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

Commit a31c082

Browse files
committed
docs($animate): clarify info about from and to for animate()
Closes #11150
1 parent 5afd545 commit a31c082

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

src/ng/animate.js

+16-4
Original file line numberDiff line numberDiff line change
@@ -552,10 +552,22 @@ var $AnimateProvider = ['$provide', function($provide) {
552552
* @kind function
553553
*
554554
* @description Performs an inline animation on the element which applies the provided to and from CSS styles to the element.
555-
* If any detected CSS transition, keyframe or JavaScript matches the provided className value then the animation will take
556-
* on the provided styles. For example, if a transition animation is set for the given className then the provided from and
557-
* to styles will be applied alongside the given transition. If a JavaScript animation is detected then the provided styles
558-
* will be given in as function parameters into the `animate` method (or as apart of the `options` parameter).
555+
* If any detected CSS transition, keyframe or JavaScript matches the provided className value, then the animation will take
556+
* on the provided styles. For example, if a transition animation is set for the given className then the provided `from` and
557+
* `to` styles will be applied alongside the given transition. If the CSS style provided in `from` does not have a corresponding
558+
* style in `to`, the style in `from` is applied immediately, and no animation is run.
559+
* If a JavaScript animation is detected then the provided styles will be given in as function parameters into the `animate`
560+
* method (or as part of the `options` parameter):
561+
*
562+
* ```js
563+
* ngModule.animation('.my-inline-animation', function() {
564+
* return {
565+
* animate : function(element, className, from, to, done) {
566+
* //styles
567+
* }
568+
* }
569+
* });
570+
* ```
559571
*
560572
* @param {DOMElement} element the element which the CSS styles will be applied to
561573
* @param {object} from the from (starting) CSS styles that will be applied to the element and across the animation.

0 commit comments

Comments
 (0)