Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 586b6e8

Browse files
FRSgitgkalpak
FRSgit
authored and
gkalpak
committed
docs(ngAnimate): refactor of ngAnimate docs
- Synced "animation aware" directives tables in API docs and "Animation" guide. - Sorted tables alphabetically. - Added info about `ngAnimateSwap` directive. References #16561 Closes #16581
1 parent 459997b commit 586b6e8

File tree

2 files changed

+35
-24
lines changed

2 files changed

+35
-24
lines changed

‎docs/content/guide/animations.ngdoc

+13-10
Original file line numberDiff line numberDiff line change
@@ -222,23 +222,26 @@ triggered:
222222

223223
| Directive | Supported Animations |
224224
|-------------------------------------------------------------------------------|---------------------------------------------------------------------------|
225-
| {@link ng.directive:ngRepeat#animations ngRepeat} | enter, leave, and move |
226-
| {@link ng.directive:ngIf#animations ngIf} | enter and leave |
227-
| {@link ng.directive:ngSwitch#animations ngSwitch} | enter and leave |
228-
| {@link ng.directive:ngInclude#animations ngInclude} | enter and leave |
229-
| {@link ngRoute.directive:ngView#animations ngView} | enter and leave |
230-
| {@link module:ngMessages#animations ngMessage / ngMessageExp} | enter and leave |
225+
| {@link ng.directive:form#animations form / ngForm} | add and remove ({@link ng.directive:form#css-classes various classes}) |
226+
| {@link ngAnimate.directive:ngAnimateSwap#animations ngAnimateSwap} | enter and leave |
231227
| {@link ng.directive:ngClass#animations ngClass / {{class}​}} | add and remove |
232228
| {@link ng.directive:ngClassEven#animations ngClassEven} | add and remove |
233229
| {@link ng.directive:ngClassOdd#animations ngClassOdd} | add and remove |
234230
| {@link ng.directive:ngHide#animations ngHide} | add and remove (the `ng-hide` class) |
235-
| {@link ng.directive:ngShow#animations ngShow} | add and remove (the `ng-hide` class) |
236-
| {@link ng.directive:ngModel#animations ngModel} | add and remove ({@link ng.directive:ngModel#css-classes various classes}) |
237-
| {@link ng.directive:form#animations form / ngForm} | add and remove ({@link ng.directive:form#css-classes various classes}) |
231+
| {@link ng.directive:ngIf#animations ngIf} | enter and leave |
232+
| {@link ng.directive:ngInclude#animations ngInclude} | enter and leave |
233+
| {@link module:ngMessages#animations ngMessage / ngMessageExp} | enter and leave |
238234
| {@link module:ngMessages#animations ngMessages} | add and remove (the `ng-active`/`ng-inactive` classes) |
235+
| {@link ng.directive:ngModel#animations ngModel} | add and remove ({@link ng.directive:ngModel#css-classes various classes}) |
236+
| {@link ng.directive:ngRepeat#animations ngRepeat} | enter, leave, and move |
237+
| {@link ng.directive:ngShow#animations ngShow} | add and remove (the `ng-hide` class) |
238+
| {@link ng.directive:ngSwitch#animations ngSwitch} | enter and leave |
239+
| {@link ngRoute.directive:ngView#animations ngView} | enter and leave |
240+
241+
(More information can be found by visiting the documentation associated with each directive.)
239242

240243
For a full breakdown of the steps involved during each animation event, refer to the
241-
{@link ng.$animate API docs}.
244+
{@link ng.$animate `$animate` API docs}.
242245

243246
## How do I use animations in my own directives?
244247

‎src/ngAnimate/module.js

+22-14
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,28 @@
1717
* ## Directive Support
1818
* The following directives are "animation aware":
1919
*
20-
* | Directive | Supported Animations |
21-
* |----------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------|
22-
* | {@link ng.directive:ngRepeat#animations ngRepeat} | enter, leave and move |
23-
* | {@link ngRoute.directive:ngView#animations ngView} | enter and leave |
24-
* | {@link ng.directive:ngInclude#animations ngInclude} | enter and leave |
25-
* | {@link ng.directive:ngSwitch#animations ngSwitch} | enter and leave |
26-
* | {@link ng.directive:ngIf#animations ngIf} | enter and leave |
27-
* | {@link ng.directive:ngClass#animations ngClass} | add and remove (the CSS class(es) present) |
28-
* | {@link ng.directive:ngShow#animations ngShow} & {@link ng.directive:ngHide#animations ngHide} | add and remove (the ng-hide class value) |
29-
* | {@link ng.directive:form#animations form} & {@link ng.directive:ngModel#animations ngModel} | add and remove (dirty, pristine, valid, invalid & all other validations) |
30-
* | {@link module:ngMessages#animations ngMessages} | add and remove (ng-active & ng-inactive) |
31-
* | {@link module:ngMessages#animations ngMessage} | enter and leave |
32-
*
33-
* (More information can be found by visiting each the documentation associated with each directive.)
20+
* | Directive | Supported Animations |
21+
* |-------------------------------------------------------------------------------|---------------------------------------------------------------------------|
22+
* | {@link ng.directive:form#animations form / ngForm} | add and remove ({@link ng.directive:form#css-classes various classes}) |
23+
* | {@link ngAnimate.directive:ngAnimateSwap#animations ngAnimateSwap} | enter and leave |
24+
* | {@link ng.directive:ngClass#animations ngClass / {{class}​}} | add and remove |
25+
* | {@link ng.directive:ngClassEven#animations ngClassEven} | add and remove |
26+
* | {@link ng.directive:ngClassOdd#animations ngClassOdd} | add and remove |
27+
* | {@link ng.directive:ngHide#animations ngHide} | add and remove (the `ng-hide` class) |
28+
* | {@link ng.directive:ngIf#animations ngIf} | enter and leave |
29+
* | {@link ng.directive:ngInclude#animations ngInclude} | enter and leave |
30+
* | {@link module:ngMessages#animations ngMessage / ngMessageExp} | enter and leave |
31+
* | {@link module:ngMessages#animations ngMessages} | add and remove (the `ng-active`/`ng-inactive` classes) |
32+
* | {@link ng.directive:ngModel#animations ngModel} | add and remove ({@link ng.directive:ngModel#css-classes various classes}) |
33+
* | {@link ng.directive:ngRepeat#animations ngRepeat} | enter, leave, and move |
34+
* | {@link ng.directive:ngShow#animations ngShow} | add and remove (the `ng-hide` class) |
35+
* | {@link ng.directive:ngSwitch#animations ngSwitch} | enter and leave |
36+
* | {@link ngRoute.directive:ngView#animations ngView} | enter and leave |
37+
*
38+
* (More information can be found by visiting the documentation associated with each directive.)
39+
*
40+
* For a full breakdown of the steps involved during each animation event, refer to the
41+
* {@link ng.$animate `$animate` API docs}.
3442
*
3543
* ## CSS-based Animations
3644
*

0 commit comments

Comments
 (0)