AngularJS: API: ng/provider/$animateProvider


  1. - $animate
  2. - provider in module ng

Default implementation of $animate that doesn't perform any animations, instead just synchronously performs DOM updates and calls done() callbacks.

In order to enable animations the ngAnimate module has to be loaded.

To see the functional implementation check out src/ngAnimate/animate.js


  • register(name, factory);

    Registers a new injectable animation factory function. The factory function produces the animation object which contains callback functions for each event that is expected to be animated.

    • eventFn: function(Element, doneFunction) The element to animate, the doneFunction must be called once the element animation is complete. If a function is returned then the animation service will use this function to cancel the animation whenever a cancel event is triggered.
      return {
        eventFn : function(element, done) {
          //code to run the animation
          //once complete, then run done()
          return function cancellationFunction() {
            //code to cancel the animation


    Param Type Details
    name string

    The name of the animation.

    factory Function

    The factory function that will be executed to return the animation object.

  • classNameFilter([expression]);

    Sets and/or returns the CSS class regular expression that is checked when performing an animation. Upon bootstrap the classNameFilter value is not set at all and will therefore enable $animate to attempt to perform an animation on any element. When setting the classNameFilter value, animations will only be performed on elements that successfully match the filter expression. This in turn can boost performance for low-powered devices as well as applications containing a lot of structural operations.


    Param Type Details

    The className expression which will be checked against all animations



    The current CSS className expression value. If null then there is no expression value