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

Commit b5b969d

Browse files
committed
docs($animate): detail options object
- Document options object used in various $animate methods
1 parent cfc8b41 commit b5b969d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/ng/animate.js

+8-1
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,14 @@ var $AnimateProvider = ['$provide', function($provide) {
420420
* @param {DOMElement} parent the parent element which will append the element as
421421
* a child (so long as the after element is not present)
422422
* @param {DOMElement=} after the sibling element after which the element will be appended
423-
* @param {object=} options an optional collection of options/styles that will be applied to the element
423+
* @param {object=} options an optional collection of options/styles that will be applied to the element.
424+
* The object has the following properties:
425+
*
426+
* - **addClass** - `{string}` - space-separated CSS classes to add to element
427+
* - **from** - `{Object}` - CSS properties & values from beginning of animation
428+
* - **removeClass** - `{string}` - space-separated CSS classes to remove from element
429+
* - **to** - `{Object}` - CSS properties & values at end of animation
430+
*
424431
*
425432
* @return {Promise} the animation callback promise
426433
*/

0 commit comments

Comments
 (0)