docs(ngShowHide): improve clarity

Closes #4099
This commit is contained in:
Dave Peticolas 2013-09-21 17:22:22 -07:00 committed by Pete Bacon Darwin
parent 31c56f5400
commit 50194147ac

View file

@ -5,10 +5,10 @@
* @name ng.directive:ngShow * @name ng.directive:ngShow
* *
* @description * @description
* The `ngShow` directive shows and hides the given HTML element conditionally based on the expression * The `ngShow` directive shows or hides the given HTML element based on the expression
* provided to the ngShow attribute. The show and hide mechanism is achieved by removing and adding * provided to the ngShow attribute. The element is shown or hidden by removing or adding
* the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is a predefined CSS class present * the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
* in AngularJS which sets the display style to none (using an !important flag). * in AngularJS and sets the display style to none (using an !important flag).
* *
* <pre> * <pre>
* <!-- when $scope.myValue is truthy (element is visible) --> * <!-- when $scope.myValue is truthy (element is visible) -->
@ -54,9 +54,9 @@
* ## A note about animations with ngShow * ## A note about animations with ngShow
* *
* Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression
* is true and false. This system works similar to the animation system present with ngClass, however, the * is true and false. This system works like the animation system present with ngClass except that
* only difference is that you must also include the !important flag to override the display property so * you must also include the !important flag to override the display property
* that you can perform an animation when the element is hidden during the time of the animation. * so that you can perform an animation when the element is hidden during the time of the animation.
* *
* <pre> * <pre>
* // * //
@ -157,10 +157,10 @@ var ngShowDirective = ['$animate', function($animate) {
* @name ng.directive:ngHide * @name ng.directive:ngHide
* *
* @description * @description
* The `ngHide` directive shows and hides the given HTML element conditionally based on the expression * The `ngHide` directive shows or hides the given HTML element based on the expression
* provided to the ngHide attribute. The show and hide mechanism is a achieved by removing and adding * provided to the ngHide attribute. The element is shown or hidden by removing or adding
* the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is a predefined CSS class present * the `ng-hide` CSS class onto the element. The `.ng-hide` CSS class is predefined
* in AngularJS which sets the display style to none (using an !important flag). * in AngularJS and sets the display style to none (using an !important flag).
* *
* <pre> * <pre>
* <!-- when $scope.myValue is truthy (element is hidden) --> * <!-- when $scope.myValue is truthy (element is hidden) -->
@ -206,8 +206,8 @@ var ngShowDirective = ['$animate', function($animate) {
* ## A note about animations with ngHide * ## A note about animations with ngHide
* *
* Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression * Animations in ngShow/ngHide work with the show and hide events that are triggered when the directive expression
* is true and false. This system works similar to the animation system present with ngClass, however, the * is true and false. This system works like the animation system present with ngClass, except that
* only difference is that you must also include the !important flag to override the display property so * you must also include the !important flag to override the display property so
* that you can perform an animation when the element is hidden during the time of the animation. * that you can perform an animation when the element is hidden during the time of the animation.
* *
* <pre> * <pre>