docs(cheatsheet): copyedit

Fixed a few little things. I'll probably have more changes to make later, once I understand everything better.

Also added a missing syntax line.

Closes #5806
This commit is contained in:
Kathy Walrath 2015-12-10 09:52:19 -08:00
parent a66cc50168
commit 3fd898e91f
7 changed files with 21 additions and 20 deletions

View File

@ -9,4 +9,5 @@ Bootstrapping
syntax: syntax:
`bootstrap(MyAppComponent, [MyService, provide(...)]);`|`provide` `bootstrap(MyAppComponent, [MyService, provide(...)]);`|`provide`
description: description:
Bootstraps an application with MyAppComponent as the root component and configures the DI providers. Bootstraps an application with MyAppComponent as the root component, and
configures the app's dependency injection providers.

View File

@ -31,5 +31,4 @@ Conditionally swaps the contents of the div by selecting one of the embedded tem
syntax: syntax:
`<div [ngClass]="{active: isActive, disabled: isDisabled}">`|`[ngClass]` `<div [ngClass]="{active: isActive, disabled: isDisabled}">`|`[ngClass]`
description: description:
Binds the presence of css classes on the element to the truthiness of the associated map values. The right-hand side expression should return {class-name: true/false} map. Binds the presence of CSS classes on the element to the truthiness of the associated map values. The right-hand side expression should return {class-name: true/false} map.

View File

@ -17,7 +17,7 @@ syntax:
`template: 'Hello {{name}}' `template: 'Hello {{name}}'
templateUrl: 'my-component.html'`|`template:`|`templateUrl:` templateUrl: 'my-component.html'`|`template:`|`templateUrl:`
description: description:
Inline template / external template url of the component's view. Inline template / external template URL of the component's view.
@cheatsheetItem @cheatsheetItem
@ -25,7 +25,7 @@ syntax:
`styles: ['.primary {color: red}'] `styles: ['.primary {color: red}']
styleUrls: ['my-component.css']`|`styles:`|`styleUrls:` styleUrls: ['my-component.css']`|`styles:`|`styleUrls:`
description: description:
List of inline css styles / external stylesheet urls for styling components view. List of inline CSS styles / external stylesheet URLs for styling components view.
@cheatsheetItem @cheatsheetItem
@ -39,4 +39,4 @@ List of directives used in the the components template.
syntax: syntax:
`pipes: [MyPipe, OtherPipe]`|`pipes:` `pipes: [MyPipe, OtherPipe]`|`pipes:`
description: description:
List of pipes used in the component's template. List of pipes used in the component's template.

View File

@ -9,22 +9,22 @@ Class field decorators for directives and components
syntax: syntax:
`@Input() myProperty;`|`@Input()` `@Input() myProperty;`|`@Input()`
description: description:
Declares an input property that we can update via property binding, e.g. Declares an input property that we can update via property binding (e.g.
`<my-cmp [my-property]="someExpression">` `<my-cmp [my-property]="someExpression">`).
@cheatsheetItem @cheatsheetItem
syntax: syntax:
`@Output() myEvent = new EventEmitter();`|`@Output()` `@Output() myEvent = new EventEmitter();`|`@Output()`
description: description:
Declares an output property that fires events to which we can subscribe with an event binding, e.g. `<my-cmp (my-event)="doSomething()">` Declares an output property that fires events to which we can subscribe with an event binding (e.g. `<my-cmp (my-event)="doSomething()">`).
@cheatsheetItem @cheatsheetItem
syntax: syntax:
`@HostBinding('[class.valid]') isValid;`|`@HostBinding('[class.valid]')` `@HostBinding('[class.valid]') isValid;`|`@HostBinding('[class.valid]')`
description: description:
Binds a host element property (e.g. css class valid) to directive/component property (e.g. isValid) Binds a host element property (e.g. CSS class valid) to directive/component property (e.g. isValid).
@ -32,7 +32,7 @@ Binds a host element property (e.g. css class valid) to directive/component prop
syntax: syntax:
`@HostListener('click', ['$event']) onClick(e) {...}`|`@HostListener('click', ['$event'])` `@HostListener('click', ['$event']) onClick(e) {...}`|`@HostListener('click', ['$event'])`
description: description:
Subscribes to a host element event (e.g. click) with a directive/component method (e.g., onClick), optionally passing an argument ($event) Subscribes to a host element event (e.g. click) with a directive/component method (e.g. onClick), optionally passing an argument ($event).
@cheatsheetItem @cheatsheetItem

View File

@ -9,7 +9,7 @@ Directive configuration
syntax: syntax:
`selector: '.cool-button:not(a)'`|`selector:` `selector: '.cool-button:not(a)'`|`selector:`
description: description:
Specifies a css selector that identifies this directive within a template. Supported selectors include: `element`, Specifies a CSS selector that identifies this directive within a template. Supported selectors include `element`,
`[attribute]`, `.class`, and `:not()`. `[attribute]`, `.class`, and `:not()`.
Does not support parent-child relationship selectors. Does not support parent-child relationship selectors.

View File

@ -17,9 +17,9 @@ class MyComponent() {}`|`@RouteConfig`
syntax(dart): syntax(dart):
`@RouteConfig(const [ `@RouteConfig(const [
const Route(path: '/:myParam', component: MyComponent, name: 'MyCmp' ), const Route(path: '/:myParam', component: MyComponent, name: 'MyCmp' ),
])` ])`|`@RouteConfig`
description: description:
Configures routes for the decorated component. Supports static, parameterized and wildcard routes. Configures routes for the decorated component. Supports static, parameterized, and wildcard routes.
@cheatsheetItem @cheatsheetItem
@ -30,6 +30,7 @@ Marks the location to load the component of the active route.
@cheatsheetItem @cheatsheetItem
syntax:
`<a [routerLink]="[ '/MyCmp', {myParam: 'value' } ]">`|`[routerLink]` `<a [routerLink]="[ '/MyCmp', {myParam: 'value' } ]">`|`[routerLink]`
description: description:
Creates a link to a different view based on a route instruction consisting of a route name and optional parameters. The route name matches the as property of a configured route. Add the '/' prefix to navigate to a root route; add the './' prefix for a child route. Creates a link to a different view based on a route instruction consisting of a route name and optional parameters. The route name matches the as property of a configured route. Add the '/' prefix to navigate to a root route; add the './' prefix for a child route.
@ -41,21 +42,21 @@ syntax(js ts):
syntax(dart): syntax(dart):
`@CanActivate(() => ...)class MyComponent() {}`|`@CanActivate` `@CanActivate(() => ...)class MyComponent() {}`|`@CanActivate`
description: description:
A component decorator defining a function that the router should call first to determine if it should activate this component. Should return a boolean or a promise. A component decorator defining a function that the router should call first to determine if it should activate this component. Should return a boolean or a {@target js ts}promise{@endtarget}{@target dart}future{@endtarget}.
@cheatsheetItem @cheatsheetItem
syntax: syntax:
`routerOnActivate(nextInstruction, prevInstruction) { ... }`|`routerOnActivate` `routerOnActivate(nextInstruction, prevInstruction) { ... }`|`routerOnActivate`
description: description:
After navigating to a component, the router calls component's routerOnActivate method (if defined). After navigating to a component, the router calls the component's routerOnActivate method (if defined).
@cheatsheetItem @cheatsheetItem
syntax: syntax:
`routerCanReuse(nextInstruction, prevInstruction) { ... }`|`routerCanReuse` `routerCanReuse(nextInstruction, prevInstruction) { ... }`|`routerCanReuse`
description: description:
The router calls a component's routerCanReuse method (if defined) to determine whether to reuse the instance or destroy it and create a new instance. Should return a boolean or a promise. The router calls a component's routerCanReuse method (if defined) to determine whether to reuse the instance or destroy it and create a new instance. Should return a boolean or a {@target js ts}promise{@endtarget}{@target dart}future{@endtarget}.
@cheatsheetItem @cheatsheetItem
@ -69,11 +70,11 @@ The router calls the component's routerOnReuse method (if defined) when it re-us
syntax: syntax:
`routerCanDeactivate(nextInstruction, prevInstruction) { ... }`|`routerCanDeactivate` `routerCanDeactivate(nextInstruction, prevInstruction) { ... }`|`routerCanDeactivate`
description: description:
The router calls the routerCanDeactivate methods (if defined) of every component that would be removed after a navigation. The navigation proceeds if and only if all such methods return true or a promise that is resolved. The router calls the routerCanDeactivate methods (if defined) of every component that would be removed after a navigation. The navigation proceeds if and only if all such methods return true or a {@target js ts}promise that is resolved{@endtarget}{@target dart}future that completes successfully{@endtarget}.
@cheatsheetItem @cheatsheetItem
syntax: syntax:
`routerOnDeactivate(nextInstruction, prevInstruction) { ... }`|`routerOnDeactivate` `routerOnDeactivate(nextInstruction, prevInstruction) { ... }`|`routerOnDeactivate`
description: description:
Called before the directive is removed as the result of a route change. May return a promise that pauses removing the directive until the promise resolves. Called before the directive is removed as the result of a route change. May return a {@target js ts}promise{@endtarget}{@target dart}future{@endtarget} that pauses removing the directive until the {@target js ts}promise resolves{@endtarget}{@target dart}future completes{@endtarget}.

View File

@ -19,7 +19,7 @@ Binds attribute `role` to the result of expression `myAriaRole`.
syntax: syntax:
`<div [class.extra-sparkle]="isDelightful">`|`[class.extra-sparkle]` `<div [class.extra-sparkle]="isDelightful">`|`[class.extra-sparkle]`
description: description:
Binds the presence of the css class `extra-sparkle` on the element to the truthiness of the expression `isDelightful`. Binds the presence of the CSS class `extra-sparkle` on the element to the truthiness of the expression `isDelightful`.
@cheatsheetItem @cheatsheetItem
syntax: syntax: