@@ -552,10 +552,22 @@ var $AnimateProvider = ['$provide', function($provide) {
552
552
* @kind function
553
553
*
554
554
* @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
+ * ```
559
571
*
560
572
* @param {DOMElement } element the element which the CSS styles will be applied to
561
573
* @param {object } from the from (starting) CSS styles that will be applied to the element and across the animation.
0 commit comments