cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(Component): API docs for .encapsulation and .interpolation

Browse Source
This commit is contained in:
Victor Berchet 2016-09-20 14:21:06 -07:00 committed by Rado Kirov
parent f23b22a0f4
commit 136621ebc9
1 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
modules/@angular/core/src/metadata/directives.ts
View File

@ -448,15 +448,15 @@ export interface ComponentDecorator {
* * **changeDetection** - change detection strategy used by this component * * **changeDetection** - change detection strategy used by this component
* * **encapsulation** - style encapsulation strategy used by this component * * **encapsulation** - style encapsulation strategy used by this component
* * **entryComponents** - list of components that are dynamically inserted into the view of this * * **entryComponents** - list of components that are dynamically inserted into the view of this
* component * component
* * **exportAs** - name under which the component instance is exported in a template * * **exportAs** - name under which the component instance is exported in a template
* * **host** - map of class property to host element bindings for events, properties and * * **host** - map of class property to host element bindings for events, properties and
* attributes * attributes
* * **inputs** - list of class property names to data-bind as component inputs * * **inputs** - list of class property names to data-bind as component inputs
* * **interpolation** - custom interpolation markers used in this component's template * * **interpolation** - custom interpolation markers used in this component's template
* * **moduleId** - ES/CommonJS module id of the file in which this component is defined * * **moduleId** - ES/CommonJS module id of the file in which this component is defined
* * **outputs** - list of class property names that expose output events that others can * * **outputs** - list of class property names that expose output events that others can
* subscribe to * subscribe to
* * **providers** - list of providers available to this component and its children * * **providers** - list of providers available to this component and its children
* * **queries** - configure queries that can be injected into the component * * **queries** - configure queries that can be injected into the component
* * **selector** - css selector that identifies this component in a template * * **selector** - css selector that identifies this component in a template
@ -655,20 +655,33 @@ export interface Component extends Directive {
animations?: AnimationEntryMetadata[]; animations?: AnimationEntryMetadata[];
/** /**
* Specify how the template and the styles should be encapsulated. * Specifies how the template and the styles should be encapsulated:
* The default is {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} if the view * - {@link ViewEncapsulation#Native `ViewEncapsulation.Native`} to use shadow roots - only works
* has styles, * if natively available on the platform,
* otherwise {@link ViewEncapsulation#None `ViewEncapsulation.None`}. * - {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} to use shimmed CSS that
* emulates the native behavior,
* - {@link ViewEncapsulation#None `ViewEncapsulation.None`} to use global CSS without any
* encapsulation.
*
* When no `encapsulation` is defined for the component, the default value from the
* {@link CompilerConfig} is used. The default is `ViewEncapsulation.Emulated`}. Provide a new
* `CompilerConfig` to override this value.
*
* If the encapsulation is set to `ViewEncapsulation.Emulated` and the component has no `styles`
* nor `styleUrls` the encapsulation will automatically be switched to `ViewEncapsulation.None`.
*/ */
encapsulation?: ViewEncapsulation; encapsulation?: ViewEncapsulation;
/**
* Overrides the default encapsulation start and end delimiters (respectively `{{` and `}}`)
*/
interpolation?: [string, string]; interpolation?: [string, string];
/** /**
* Defines the components that should be compiled as well when * Defines the components that should be compiled as well when
* this component is defined. For each components listed here, * this component is defined. For each components listed here,
* Angular will create a {@link ComponentFactory ComponentFactory} and store it in the * Angular will create a {@link ComponentFactory} and store it in the
* {@link ComponentFactoryResolver ComponentFactoryResolver}. * {@link ComponentFactoryResolver}.
*/ */
entryComponents?: Array<Type<any>|any[]>; entryComponents?: Array<Type<any>|any[]>;
} }