docs(CSSClass): add documentation

Closes #2933
This commit is contained in:
Pawel Kozlowski 2015-06-19 09:41:58 +02:00 committed by Tobias Bosch
parent bab271fcb4
commit f827e1532e
1 changed files with 22 additions and 0 deletions

View File

@ -8,6 +8,28 @@ import {IterableChanges} from 'angular2/src/change_detection/pipes/iterable_chan
import {isPresent, isString, StringWrapper} from 'angular2/src/facade/lang'; import {isPresent, isString, StringWrapper} from 'angular2/src/facade/lang';
import {ListWrapper, StringMapWrapper, isListLikeIterable} from 'angular2/src/facade/collection'; import {ListWrapper, StringMapWrapper, isListLikeIterable} from 'angular2/src/facade/collection';
/**
* Adds and removes CSS classes based on an {expression} value.
*
* The result of expression is used to add and remove CSS classes using the following logic,
* based on expression's value type:
* - {string} - all the CSS classes (space - separated) are added
* - {Array} - all the CSS classes (Array elements) are added
* - {Object} - each key corresponds to a CSS class name while values
* are interpreted as {boolean} expression. If a given expression
* evaluates to {true} a corresponding CSS class is added - otherwise
* it is removed.
*
* # Example:
*
* ```
* <div class="message" [class]="{error: errorCount > 0}">
* Please check errors.
* </div>
* ```
*
* @exportedAs angular2/directives
*/
@Directive({selector: '[class]', lifecycle: [onCheck], properties: ['rawClass: class']}) @Directive({selector: '[class]', lifecycle: [onCheck], properties: ['rawClass: class']})
export class CSSClass { export class CSSClass {
_pipe: Pipe; _pipe: Pipe;