angular-animate

What is angular-animate?

The angular-animate package is an AngularJS module that provides support for JavaScript, CSS3 transition, and CSS3 keyframe animation hooks within your AngularJS applications. It allows you to create smooth, complex animations for various elements and states in your application.

What are angular-animate's main functionalities?

CSS-based animations

This feature allows you to define CSS classes for entering and leaving animations. The .ng-enter and .ng-leave classes are used to define the starting state of the animation, while the .ng-enter-active and .ng-leave-active classes define the end state.

/* CSS code */
.fade.ng-enter {
  transition: 0.5s linear all;
  opacity: 0;
}
.fade.ng-enter-active {
  opacity: 1;
}
.fade.ng-leave {
  transition: 0.5s linear all;
  opacity: 1;
}
.fade.ng-leave-active {
  opacity: 0;
}

JavaScript-based animations

This feature allows you to define animations using JavaScript. You can create custom animations for entering and leaving elements by manipulating their CSS properties and using jQuery's animate function.

// JavaScript code
angular.module('myApp', ['ngAnimate'])
  .animation('.slide', function() {
    return {
      enter: function(element, done) {
        element.css({
          position: 'relative',
          left: '-10px',
          opacity: 0
        });
        element.animate({
          left: '0px',
          opacity: 1
        }, 1000, done);
      },
      leave: function(element, done) {
        element.css({
          position: 'relative',
          left: '0px',
          opacity: 1
        });
        element.animate({
          left: '-10px',
          opacity: 0
        }, 1000, done);
      }
    };
  });

ngAnimate directive

The ngAnimate directive can be used to apply animations to elements within an AngularJS application. In this example, the .fade class is applied to each item in the ng-repeat directive, and the corresponding CSS animations are triggered when items are added or removed.

<div ng-app="myApp" ng-controller="myCtrl">
  <div ng-repeat="item in items" class="fade">
    {{item}}
  </div>
</div>

<script>
angular.module('myApp', ['ngAnimate'])
  .controller('myCtrl', function($scope) {
    $scope.items = ['Item 1', 'Item 2', 'Item 3'];
  });
</script>

Other packages similar to angular-animate

ng2-animate

ng2-animate is an Angular (2+) module that provides a set of reusable animations for Angular applications. It offers a variety of pre-built animations that can be easily applied to elements, making it simpler to add animations without writing custom CSS or JavaScript. Compared to angular-animate, ng2-animate is designed for newer versions of Angular and provides a more modern approach to animations.

react-transition-group

react-transition-group is a popular library for managing animations in React applications. It provides components like Transition, CSSTransition, and TransitionGroup to handle the entering and exiting of elements with animations. While it serves a similar purpose to angular-animate, it is specifically designed for React and offers a different API and set of features tailored to React's component-based architecture.

animejs

animejs is a lightweight JavaScript animation library that works with any JavaScript framework, including AngularJS. It provides a powerful and flexible API for creating complex animations with minimal code. Unlike angular-animate, which is tightly integrated with AngularJS, animejs is a general-purpose animation library that can be used across different frameworks and projects.

README

packaged angular-animate

This repo is for distribution on npm and bower. The source for this module is in the main AngularJS repo. Please file issues and pull requests against that repo.

Install

You can install this package either with npm or with bower.

npm

npm install angular-animate

Then add ngAnimate as a dependency for your app:

angular.module('myApp', [require('angular-animate')]);

bower

bower install angular-animate

Then add a <script> to your index.html:

<script src="/bower_components/angular-animate/angular-animate.js"></script>

Then add ngAnimate as a dependency for your app:

angular.module('myApp', ['ngAnimate']);

Documentation

Documentation is available on the AngularJS docs site.

License

The MIT License

Copyright (c) 2010-2015 Google, Inc. http://angularjs.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Changelog

1.5.0-rc.0 oblong-panoptikum (2015-12-09)

This is the first Release Candidate for AngularJS 1.5.0. Please try upgrading your applications and report any regressions or other issues you find as soon as possible.

Features

• $parse: provide a mechanism to access the locals object, $locals (0ea53503)
• $resource: add proper support for cancelling requests, $cancelRequest() (98528be3, #9332, #13050, #13058, #13210)
• ngAnimate: provide ng-[event]-prepare class for structural animations (6e18b50a)
• ngLocale: add support for standalone months (96c73a06, #3744, #10247, #12642, #12844)
• ngMock: destroy $rootScope after each test (b75c0d8d, #13433)
• ngTransclude: don't overwrite the contents with an unfilled optional slot (0812af49, #13426)
• ngView: reference resolved locals in scope, resolveAs: '$resolve' (983b0598, #13400)

Bug Fixes

• $compile:
  • swap keys and values for transclude definition object (c3a26911, #13439)
  • include non-elements in default transclusion slot (df6fade6)
  • support merging special attribute names in replace directives (a5ff651a, #13317, #13318)
• $http: throw if url passed is not a string (6628b4f1, #12925, #13444)
• $parse:
  • prevent assignment on constructor properties (5a674f3b, #13417)
  • handle interceptors with undefined expressions (4473b81c)
• $sanitize: blacklist SVG <use> elements (7a668cdd, #13453)
• formatNumber: cope with large and small number corner cases (6a0686d4, #13394, #8674, #12709, #8705, #12707, #10246, #10252)
• input: add missing chars to URL validation regex (e4bb8387, #13379, #13460)
• ngAnimate:
  • consider options.delay value for closing timeout (7ffb2d3c, #13355, #13363)
  • ensure animate runner is the same with and without animations (546a277d, #13205, #13347)
  • ignore children without animation data when closing them (77419cf1, #11992, #13424)
  • do not alter the provided options data (193153c3, #13040, #13175)
• ngMock: clear out $providerInjector after each test (a72c12bd, #13397, #13416)
• ngOptions: don't $dirty multiple select after compilation (c7a2028a, #13211, #13326)
• ngTransclude:
  • don't replace existing content if no transcluded content exists (c3ae6ed7, #11839)
  • fix case where ngTransclude attribute value equals its key (7ddbc9aa, #12934, #13383)

Breaking Changes

• $compile: due to c3a26911,

This is only a breaking change to a feature that was added in beta 2. If you have not started using multi-slot transclusion then this will not affect you.

The keys and values for the transclude map of the directive definition have been swapped around to be more consistent with the other maps, such as scope and bindToController.

Now the key is the slot name and the value is a normalized element selector.

• $resource: due to 98528be3,

Using a promise as timeout is no longer supported and will log a warning. It never worked the way it was supposed to anyway.

Before:

var deferred = $q.defer();
var User = $resource('/api/user/:id', {id: '@id'}, {
  get: {method: 'GET', timeout: deferred.promise}
});

var user = User.get({id: 1});   // sends a request
deferred.resolve();             // aborts the request

// Now, we need to re-define `User` passing a new promise as `timeout`
// or else all subsequent requests from `someAction` will be aborted
User = $resource(...);
user = User.get({id: 2});

After:

var User = $resource('/api/user/:id', {id: '@id'}, {
  get: {method: 'GET', cancellable: true}
});

var user = User.get({id: 1});   // sends a request
user.$cancelRequest();      // aborts the request

user = User.get({id: 2});

• $sanitize: due to 7a668cdd,

The $sanitize service will now remove instances of the <use> tag from the content passed to it.

This element is used to import external SVG resources, which is a security risk as the $sanitize service does not have access to the resource in order to sanitize it.

• ngView: due to 983b0598,

A new property to access route resolves is now available on the scope of the route. The default name for this property is $resolve. If your scope already contains a property with this name then it will be hidden or overwritten.

In this case, you should choose a custom name for this property, that does not collide with other properties on the scope, by specifying the resolveAs property on the route.

• $parse: due to 0ea53503,

A new property to access all the locals for an expression is now available on the scope. This property is $locals.

• If scope.$locals already exists, the way to reference this property is now this.$locals.
• If the locals themselves include a property $locals then the way to reference that is now $locals.$locals.

<a name="1.4.8"></a>