docs(showHideWhen): update description and usage

This commit is contained in:
Drew Rygh
2015-12-09 11:40:24 -06:00
parent b7bff56d25
commit 95906e921d

View File

@@ -53,12 +53,14 @@ class DisplayWhen {
/**
*
* The `show-when` attribute takes a value or expression, and only shows the element it has been added to when
* the value or expression is true. Complements the [hide-when attribute](../HideWhen).
* The `show-when` attribute takes a string that represents a plaform or screen orientation.
* The element the attribute is added to will only be shown when that platform or screen orientation is active.
* Complements the [hide-when attribute](../HideWhen).
* @usage
* ```html
* <div show-when="false">I am hidden!</div>
* <div show-when="ios">I am only visible on iOS!</div>
* ```
* @demo /docs/v2/demos/show-when/
*/
@Directive({
selector: '[show-when]',
@@ -87,12 +89,14 @@ export class ShowWhen extends DisplayWhen {
/**
*
* The `hide-when` attribute takes a value or expression, and hides the element it has been added to when
* the value or expression is true. Complements the [show-when attribute](../ShowWhen).
* The `hide-when` attribute takes a string that represents a plaform or screen orientation.
* The element the attribute is added to will only be hidden when that platform or screen orientation is active.
* Complements the [show-when attribute](../ShowWhen).
* @usage
* ```html
* <div hide-when="true">I am hidden!</div>
* <div hide-when="android">I am hidden on Android!</div>
* ```
* @demo /docs/v2/demos/hide-when/
*/
@Directive({
selector: '[hide-when]',