514 lines
21 KiB
JSON
514 lines
21 KiB
JSON
{
|
||
"currentEnvironment": "JavaScript",
|
||
"version": {
|
||
"raw": "2.0.0-beta.0",
|
||
"major": 2,
|
||
"minor": 0,
|
||
"patch": 0,
|
||
"prerelease": [
|
||
"local"
|
||
],
|
||
"build": "sha.323393a",
|
||
"version": "2.0.0-local",
|
||
"codeName": "snapshot",
|
||
"isSnapshot": true,
|
||
"full": "2.0.0-local+sha.323393a",
|
||
"branch": "master",
|
||
"commitSHA": "323393a86201db871c2fbc6dc7bd12229b498d9a"
|
||
},
|
||
"sections": [
|
||
{
|
||
"name": "Bootstrapping",
|
||
"description": "<p>\nAvailable from the <code>ng.platform.browser</code> namespace.\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "document.addEventListener('DOMContentLoaded', function () {\n ng.platform.browser.bootstrap(MyAppComponent,\n [MyService, ng.core.provide(...)]);\n});",
|
||
"bold": [
|
||
"provide"
|
||
],
|
||
"description": "<p>Bootstraps an application with MyAppComponent as the root component and configures the DI providers. Must be wrapped in the event listener to fire when the page loads.</p>\n"
|
||
}
|
||
],
|
||
"index": 0
|
||
},
|
||
{
|
||
"name": "Template syntax",
|
||
"description": "",
|
||
"items": [
|
||
{
|
||
"syntax": "<input [value]=\"firstName\">",
|
||
"bold": [
|
||
"[value]"
|
||
],
|
||
"description": "<p>Binds property <code>value</code> to the result of expression <code>firstName</code>.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div [attr.role]=\"myAriaRole\">",
|
||
"bold": [
|
||
"[attr.role]"
|
||
],
|
||
"description": "<p>Binds attribute <code>role</code> to the result of expression <code>myAriaRole</code>.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div [class.extra-sparkle]=\"isDelightful\">",
|
||
"bold": [
|
||
"[class.extra-sparkle]"
|
||
],
|
||
"description": "<p>Binds the presence of the CSS class <code>extra-sparkle</code> on the element to the truthiness of the expression <code>isDelightful</code>.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div [style.width.px]=\"mySize\">",
|
||
"bold": [
|
||
"[style.width.px]"
|
||
],
|
||
"description": "<p>Binds style property <code>width</code> to the result of expression <code>mySize</code> in pixels. Units are optional.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<button (click)=\"readRainbow($event)\">",
|
||
"bold": [
|
||
"(click)"
|
||
],
|
||
"description": "<p>Calls method <code>readRainbow</code> when a click event is triggered on this button element (or its children) and passes in the event object.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div title=\"Hello {{ponyName}}\">",
|
||
"bold": [
|
||
"{{ponyName}}"
|
||
],
|
||
"description": "<p>Binds a property to an interpolated string, e.g. "Hello Seabiscuit". Equivalent to:\n<code><div [title]="'Hello' + ponyName"></code></p>\n"
|
||
},
|
||
{
|
||
"syntax": "<p>Hello {{ponyName}}</p>",
|
||
"bold": [
|
||
"{{ponyName}}"
|
||
],
|
||
"description": "<p>Binds text content to an interpolated string, e.g. "Hello Seabiscuit".</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<my-cmp [(title)]=\"name\">",
|
||
"bold": [
|
||
"[(title)]"
|
||
],
|
||
"description": "<p>Sets up two-way data binding. Equivalent to: <code><my-cmp [title]="name" (titleChange)="name=$event"></code></p>\n"
|
||
},
|
||
{
|
||
"syntax": "<video #movieplayer ...>\n <button (click)=\"movieplayer.play()\">\n</video>",
|
||
"bold": [
|
||
"#movieplayer",
|
||
"(click)"
|
||
],
|
||
"description": "<p>Creates a local variable <code>movieplayer</code> that provides access to the <code>video</code> element instance in data-binding and event-binding expressions in the current template.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<p *my-unless=\"myExpression\">...</p>",
|
||
"bold": [
|
||
"*my-unless"
|
||
],
|
||
"description": "<p>The <code>*</code> symbol means that the current element will be turned into an embedded template. Equivalent to:\n<code><template [myless]="myExpression"><p>...</p></template></code></p>\n"
|
||
},
|
||
{
|
||
"syntax": "<p>Card No.: {{cardNumber | myCreditCardNumberFormatter}}</p>",
|
||
"bold": [
|
||
"{{cardNumber | myCreditCardNumberFormatter}}"
|
||
],
|
||
"description": "<p>Transforms the current value of expression <code>cardNumber</code> via the pipe called <code>creditCardNumberFormatter</code>.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<p>Employer: {{employer?.companyName}}</p>",
|
||
"bold": [
|
||
"{{employer?.companyName}}"
|
||
],
|
||
"description": "<p>The Elvis operator (<code>?</code>) means that the <code>employer</code> field is optional and if <code>undefined</code>, the rest of the expression should be ignored.</p>\n"
|
||
}
|
||
],
|
||
"index": 1
|
||
},
|
||
{
|
||
"name": "Built-in directives",
|
||
"description": "<p>\nAvailable from the <code>ng.common</code> namespace\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "<section *ngIf=\"showSection\">",
|
||
"bold": [
|
||
"*ngIf"
|
||
],
|
||
"description": "<p>Removes or recreates a portion of the DOM tree based on the showSection expression.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<li *ngFor=\"#item of list\">",
|
||
"bold": [
|
||
"*ngFor"
|
||
],
|
||
"description": "<p>Turns the li element and its contents into a template, and uses that to instantiate a view for each item in list.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div [ngSwitch]=\"conditionExpression\">\n <template [ngSwitchWhen]=\"case1Exp\">...</template>\n <template ngSwitchWhen=\"case2LiteralString\">...</template>\n <template ngSwitchDefault>...</template>\n</div>",
|
||
"bold": [
|
||
"[ngSwitch]",
|
||
"[ngSwitchWhen]",
|
||
"ngSwitchWhen",
|
||
"ngSwitchDefault"
|
||
],
|
||
"description": "<p>Conditionally swaps the contents of the div by selecting one of the embedded templates based on the current value of conditionExpression.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<div [ngClass]=\"{active: isActive, disabled: isDisabled}\">",
|
||
"bold": [
|
||
"[ngClass]"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
}
|
||
],
|
||
"index": 2
|
||
},
|
||
{
|
||
"name": "Forms",
|
||
"description": "<p>\nAvailable from <code>ng.common.FORM_DIRECTIVES</code>\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "<input [(ngModel)]=\"userName\">",
|
||
"bold": [
|
||
"[(ngModel)]"
|
||
],
|
||
"description": "<p>Provides two-way data-binding, parsing and validation for form controls.</p>\n"
|
||
}
|
||
],
|
||
"index": 3
|
||
},
|
||
{
|
||
"name": "Class decorators",
|
||
"description": "<p>\nAvailable from the <code>ng.core</code> namespace\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "var MyComponent = ng.core.Component({...}).Class({...})",
|
||
"bold": [
|
||
"ng.core.Component({...})"
|
||
],
|
||
"description": "<p>Declares that a class is a component and provides metadata about the component.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "var MyPipe = ng.core.Pipe({...}).Class({...})",
|
||
"bold": [
|
||
"ng.core.Pipe({...})"
|
||
],
|
||
"description": "<p>Declares that a class is a pipe and provides metadata about the pipe.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "var OtherService = ng.core.Class({constructor: function() { }});\nvar MyService = ng.core.Class({constructor: [OtherService, function(otherService) { }]});",
|
||
"bold": [
|
||
"var MyService = ng.core.Class({constructor: [OtherService, function(otherService) { }]});"
|
||
],
|
||
"description": "<p>\n\nDeclares a service to inject into a class by providing an array with the services with the final item being the function which will receive the injected services.\n</p>\n"
|
||
}
|
||
],
|
||
"index": 4
|
||
},
|
||
{
|
||
"name": "Directive configuration",
|
||
"description": "<p>\n<code>ng.core.Directive({ property1: value1, ... }).Class({...})</code>\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "selector: '.cool-button:not(a)'",
|
||
"bold": [
|
||
"selector:"
|
||
],
|
||
"description": "<p>Specifies a CSS selector that identifies this directive within a template. Supported selectors include <code>element</code>,\n<code>[attribute]</code>, <code>.class</code>, and <code>:not()</code>.</p>\n<p>Does not support parent-child relationship selectors.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "providers: [MyService, ng.core.provide(...)]",
|
||
"bold": [
|
||
"providers:"
|
||
],
|
||
"description": "<p>Array of dependency injection providers for this directive and its children.</p>\n"
|
||
}
|
||
],
|
||
"index": 5
|
||
},
|
||
{
|
||
"name": "Component configuration",
|
||
"description": "<p><code>ng.core.Component</code> extends <code>ng.core.Directive</code>,\nso the <code>ng.core.Directive</code> configuration applies to components as well\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "viewProviders: [MyService, ng.core.provide(...)]",
|
||
"bold": [
|
||
"viewProviders:"
|
||
],
|
||
"description": "<p>Array of dependency injection providers scoped to this component's view.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "template: 'Hello {{name}}'\ntemplateUrl: 'my-component.html'",
|
||
"bold": [
|
||
"template:",
|
||
"templateUrl:"
|
||
],
|
||
"description": "<p>Inline template / external template URL of the component's view.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "styles: ['.primary {color: red}']\nstyleUrls: ['my-component.css']",
|
||
"bold": [
|
||
"styles:",
|
||
"styleUrls:"
|
||
],
|
||
"description": "<p>List of inline CSS styles / external stylesheet URLs for styling component’s view.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "directives: [MyDirective, MyComponent]",
|
||
"bold": [
|
||
"directives:"
|
||
],
|
||
"description": "<p>List of directives used in the the component’s template.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "pipes: [MyPipe, OtherPipe]",
|
||
"bold": [
|
||
"pipes:"
|
||
],
|
||
"description": "<p>List of pipes used in the component's template.</p>\n"
|
||
}
|
||
],
|
||
"index": 6
|
||
},
|
||
{
|
||
"name": "Class field decorators for directives and components",
|
||
"description": "<p>\nAvailable from the <code>ng.core</code> namespace\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "ng.core.Input(myProperty, myComponent);",
|
||
"bold": [
|
||
"ng.core.Input(",
|
||
");"
|
||
],
|
||
"description": "<p>Declares an input property that we can update via property binding (e.g.\n<code><my-cmp [my-property]="someExpression"></code>).</p>\n"
|
||
},
|
||
{
|
||
"syntax": "myEvent = new ng.core.EventEmitter(); ng.core.Output(myEvent, myComponent);",
|
||
"bold": [
|
||
"ng.core.Output(",
|
||
");"
|
||
],
|
||
"description": "<p>Declares an output property that fires events to which we can subscribe with an event binding (e.g. <code><my-cmp (my-event)="doSomething()"></code>).</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.HostBinding('[class.valid]', 'isValid', myComponent);",
|
||
"bold": [
|
||
"ng.core.HostBinding('[class.valid]', 'isValid'",
|
||
");"
|
||
],
|
||
"description": "<p>Binds a host element property (e.g. CSS class valid) to directive/component property (e.g. isValid).</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.HostListener('click', ['$event'], onClick(e) {...}, myComponent);",
|
||
"bold": [
|
||
"ng.core.HostListener('click', ['$event'], onClick(e)",
|
||
");"
|
||
],
|
||
"description": "<p>Subscribes to a host element event (e.g. click) with a directive/component method (e.g. onClick), optionally passing an argument ($event).</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.ContentChild(myPredicate, 'myChildComponent', myComponent);",
|
||
"bold": [
|
||
"ng.core.ContentChild(myPredicate,",
|
||
");"
|
||
],
|
||
"description": "<p>Binds the first result of the component content query (myPredicate) to the myChildComponent property of the class.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.ContentChildren(myPredicate, 'myChildComponents', myComponent);",
|
||
"bold": [
|
||
"ng.core.ContentChildren(myPredicate,",
|
||
");"
|
||
],
|
||
"description": "<p>Binds the results of the component content query (myPredicate) to the myChildComponents property of the class.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.ViewChild(myPredicate, 'myChildComponent', myComponent);",
|
||
"bold": [
|
||
"ng.core.ViewChild(myPredicate,",
|
||
");"
|
||
],
|
||
"description": "<p>Binds the first result of the component view query (myPredicate) to the myChildComponent property of the class. Not available for directives.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.ViewChildren(myPredicate, 'myChildComponents', myComponent);",
|
||
"bold": [
|
||
"ng.core.ViewChildren(myPredicate,",
|
||
");"
|
||
],
|
||
"description": "<p>Binds the results of the component view query (myPredicate) to the myChildComponents property of the class. Not available for directives.</p>\n"
|
||
}
|
||
],
|
||
"index": 7
|
||
},
|
||
{
|
||
"name": "Directive and component change detection and lifecycle hooks",
|
||
"description": "<p>\n(implemented as component properties)</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "constructor: function(MyService, ...) { ... }",
|
||
"bold": [
|
||
"constructor: function(MyService, ...)"
|
||
],
|
||
"description": "<p>The class constructor is called before any other lifecycle hook. Use it to inject dependencies, but avoid any serious work here.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngOnChanges: function(changeRecord) { ... }",
|
||
"bold": [
|
||
"ngOnChanges: function(changeRecord)"
|
||
],
|
||
"description": "<p>Called after every change to input properties and before processing content or child views.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngOnInit: function() { ... }",
|
||
"bold": [
|
||
"ngOnInit: function()"
|
||
],
|
||
"description": "<p>Called after the constructor, initializing input properties, and the first call to ngOnChanges.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngDoCheck: function() { ... }",
|
||
"bold": [
|
||
"ngDoCheck: function()"
|
||
],
|
||
"description": "<p>Called every time that the input properties of a component or a directive are checked. Use it to extend change detection by performing a custom check.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngAfterContentInit: function() { ... }",
|
||
"bold": [
|
||
"ngAfterContentInit: function()"
|
||
],
|
||
"description": "<p>Called after ngOnInit when the component's or directive's content has been initialized.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngAfterContentChecked: function() { ... }",
|
||
"bold": [
|
||
"ngAfterContentChecked: function()"
|
||
],
|
||
"description": "<p>Called after every check of the component's or directive's content.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngAfterViewInit: function() { ... }",
|
||
"bold": [
|
||
"ngAfterViewInit: function()"
|
||
],
|
||
"description": "<p>Called after ngAfterContentInit when the component's view has been initialized. Applies to components only.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngAfterViewChecked: function() { ... }",
|
||
"bold": [
|
||
"ngAfterViewChecked: function()"
|
||
],
|
||
"description": "<p>Called after every check of the component's view. Applies to components only.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ngOnDestroy: function() { ... }",
|
||
"bold": [
|
||
"ngOnDestroy: function()"
|
||
],
|
||
"description": "<p>Called once, before the instance is destroyed.</p>\n"
|
||
}
|
||
],
|
||
"index": 8
|
||
},
|
||
{
|
||
"name": "Dependency injection configuration",
|
||
"description": "<p>\nAvailable from the <code>ng.core</code> namespace\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "ng.core.provide(MyService, {useClass: MyMockService})",
|
||
"bold": [
|
||
"provide",
|
||
"useClass"
|
||
],
|
||
"description": "<p>Sets or overrides the provider for MyService to the MyMockService class.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "ng.core.provide(MyService, {useFactory: myFactory})",
|
||
"bold": [
|
||
"provide",
|
||
"useFactory"
|
||
],
|
||
"description": "<p>Sets or overrides the provider for MyService to the myFactory factory function.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "provide(MyValue, {useValue: 41})",
|
||
"bold": [
|
||
"provide",
|
||
"useValue"
|
||
],
|
||
"description": "<p>Sets or overrides the provider for MyValue to the value 41.</p>\n"
|
||
}
|
||
],
|
||
"index": 9
|
||
},
|
||
{
|
||
"name": "Routing and navigation",
|
||
"description": "<p>\nAvailable from the <code>ng.router</code> namespace\n</p>\n",
|
||
"items": [
|
||
{
|
||
"syntax": "var MyComponent = ng.router.RouteConfig([\n { path: '/:myParam', component: MyComponent, as: 'MyCmp' },\n { path: '/staticPath', component: ..., as: ...},\n { path: '/*wildCardParam', component: ..., as: ...}\n]).Class({\n constructor: function() {}\n});",
|
||
"bold": [
|
||
"ng.router.RouteConfig"
|
||
],
|
||
"description": "<p>Configures routes for the decorated component. Supports static, parameterized, and wildcard routes.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<router-outlet></router-outlet>",
|
||
"bold": [
|
||
"router-outlet"
|
||
],
|
||
"description": "<p>Marks the location to load the component of the active route.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "<a [routerLink]=\"[ '/MyCmp', {myParam: 'value' } ]\">",
|
||
"bold": [
|
||
"[routerLink]"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "var MyComponent = ng.router.CanActivate(function() { ... }).Component({...}).Class({constructor: ...});",
|
||
"bold": [
|
||
"ng.router.CanActivate(function() { ... })"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "routerOnActivate: function(nextInstruction, prevInstruction) { ... }",
|
||
"bold": [
|
||
"routerOnActivate"
|
||
],
|
||
"description": "<p>After navigating to a component, the router calls the component's routerOnActivate method (if defined).</p>\n"
|
||
},
|
||
{
|
||
"syntax": "routerCanReuse: function(nextInstruction, prevInstruction) { ... }",
|
||
"bold": [
|
||
"routerCanReuse"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "routerOnReuse: function(nextInstruction, prevInstruction) { ... }",
|
||
"bold": [
|
||
"routerOnReuse"
|
||
],
|
||
"description": "<p>The router calls the component's routerOnReuse method (if defined) when it re-uses a component instance.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "routerCanDeactivate: function(nextInstruction, prevInstruction) { ... }",
|
||
"bold": [
|
||
"routerCanDeactivate"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
},
|
||
{
|
||
"syntax": "routerOnDeactivate: function(nextInstruction, prevInstruction) { ... }",
|
||
"bold": [
|
||
"routerOnDeactivate"
|
||
],
|
||
"description": "<p>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.</p>\n"
|
||
}
|
||
],
|
||
"index": 10
|
||
}
|
||
]
|
||
} |