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

Commit fe61088

Browse files
committed
docs: add docs for off(container)
1 parent 75bb641 commit fe61088

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/ng/animate.js

+6-1
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,9 @@ var $AnimateProvider = ['$provide', function($provide) {
326326
* // remove all the animation event listeners listening for `enter`
327327
* $animate.off('enter');
328328
*
329+
* // remove animation event listeners for all events from the container element
330+
* $animate.off(container);
331+
*
329332
* // remove all the animation event listeners listening for `enter` on the given element and its children
330333
* $animate.off('enter', container);
331334
*
@@ -334,7 +337,9 @@ var $AnimateProvider = ['$provide', function($provide) {
334337
* $animate.off('enter', container, callback);
335338
* ```
336339
*
337-
* @param {string} event the animation event (e.g. enter, leave, move, addClass, removeClass, etc...)
340+
* @param {string|DOMElement} event|container the animation event (e.g. enter, leave, move,
341+
* addClass, removeClass, etc...), or the container element. If it is the element, all other
342+
* arguments are ignored.
338343
* @param {DOMElement=} container the container element the event listener was placed on
339344
* @param {Function=} callback the callback function that was registered as the listener
340345
*/

0 commit comments

Comments
 (0)