118 lines
3.1 KiB
TypeScript
118 lines
3.1 KiB
TypeScript
import {ABSTRACT, CONST, Type} from 'angular2/src/core/facade/lang';
|
|
import {ViewEncapsulation} from 'angular2/src/core/render/api';
|
|
|
|
export {ViewEncapsulation} from 'angular2/src/core/render/api';
|
|
|
|
/**
|
|
* Declares the available HTML templates for an application.
|
|
*
|
|
* Each Angular component requires a single `@Component` and at least one `@View` annotation. The
|
|
* `@View` annotation specifies the HTML template to use, and lists the directives that are active
|
|
* within the template.
|
|
*
|
|
* When a component is instantiated, the template is loaded into the component's shadow root, and
|
|
* the expressions and statements in the template are evaluated against the component.
|
|
*
|
|
* For details on the `@Component` annotation, see {@link ComponentMetadata}.
|
|
*
|
|
* ## Example
|
|
*
|
|
* ```
|
|
* @Component({
|
|
* selector: 'greet'
|
|
* })
|
|
* @View({
|
|
* template: 'Hello {{name}}!',
|
|
* directives: [GreetUser, Bold]
|
|
* })
|
|
* class Greet {
|
|
* name: string;
|
|
*
|
|
* constructor() {
|
|
* this.name = 'World';
|
|
* }
|
|
* }
|
|
* ```
|
|
*/
|
|
@CONST()
|
|
export class ViewMetadata {
|
|
/**
|
|
* Specifies a template URL for an Angular component.
|
|
*
|
|
* NOTE: either `templateUrl` or `template` should be used, but not both.
|
|
*/
|
|
templateUrl: string;
|
|
|
|
/**
|
|
* Specifies an inline template for an Angular component.
|
|
*
|
|
* NOTE: either `templateUrl` or `template` should be used, but not both.
|
|
*/
|
|
template: string;
|
|
|
|
/**
|
|
* Specifies stylesheet URLs for an Angular component.
|
|
*/
|
|
styleUrls: string[];
|
|
|
|
/**
|
|
* Specifies an inline stylesheet for an Angular component.
|
|
*/
|
|
styles: string[];
|
|
|
|
/**
|
|
* Specifies a list of directives that can be used within a template.
|
|
*
|
|
* Directives must be listed explicitly to provide proper component encapsulation.
|
|
*
|
|
* ## Example
|
|
*
|
|
* ```javascript
|
|
* @Component({
|
|
* selector: 'my-component'
|
|
* })
|
|
* @View({
|
|
* directives: [NgFor]
|
|
* template: '
|
|
* <ul>
|
|
* <li *ng-for="#item of items">{{item}}</li>
|
|
* </ul>'
|
|
* })
|
|
* class MyComponent {
|
|
* }
|
|
* ```
|
|
*/
|
|
// TODO(tbosch): use Type | Binding | any[] when Dart supports union types,
|
|
// as otherwise we would need to import Binding type and Dart would warn
|
|
// for an unused import.
|
|
directives: Array<Type | any | any[]>;
|
|
|
|
pipes: Array<Type | any | any[]>;
|
|
|
|
/**
|
|
* Specify how the template and the styles should be encapsulated.
|
|
* The default is {@link ViewEncapsulation#Emulated `ViewEncapsulation.Emulated`} if the view
|
|
* has styles,
|
|
* otherwise {@link ViewEncapsulation#None `ViewEncapsulation.None`}.
|
|
*/
|
|
encapsulation: ViewEncapsulation;
|
|
|
|
constructor({templateUrl, template, directives, pipes, encapsulation, styles, styleUrls}: {
|
|
templateUrl?: string,
|
|
template?: string,
|
|
directives?: Array<Type | any | any[]>,
|
|
pipes?: Array<Type | any | any[]>,
|
|
encapsulation?: ViewEncapsulation,
|
|
styles?: string[],
|
|
styleUrls?: string[],
|
|
} = {}) {
|
|
this.templateUrl = templateUrl;
|
|
this.template = template;
|
|
this.styleUrls = styleUrls;
|
|
this.styles = styles;
|
|
this.directives = directives;
|
|
this.pipes = pipes;
|
|
this.encapsulation = encapsulation;
|
|
}
|
|
}
|