@material/animation

What is @material/animation?

@material/animation is a utility package from Material Design Components (MDC) that provides a set of functions and constants to help create smooth and consistent animations. It is designed to be used with other MDC components to ensure that animations follow Material Design guidelines.

What are @material/animation's main functionalities?

Animation Curves

Provides predefined animation curves such as easeInOut, easeOut, and easeIn that can be used to create smooth transitions and animations.

const { easeInOut, easeOut, easeIn } = require('@material/animation');

// Example usage in a CSS-in-JS style object
const styles = {
  transition: `all 250ms ${easeInOut}`
};

Animation Durations

Includes standard durations for animations, such as short, medium, and long, to ensure consistency across different components.

const { duration } = require('@material/animation');

// Example usage in a CSS-in-JS style object
const styles = {
  transitionDuration: `${duration.standard}ms`
};

Keyframe Animations

Provides utility functions to handle keyframe animations and ensure compatibility across different browsers.

const { getCorrectEventName } = require('@material/animation');

// Example usage in JavaScript
const animationEndEvent = getCorrectEventName(window, 'animationend');
element.addEventListener(animationEndEvent, () => {
  console.log('Animation ended');
});

Other packages similar to @material/animation

animejs

Anime.js is a lightweight JavaScript animation library with a simple, yet powerful API. It supports various types of animations including CSS properties, SVG, DOM attributes, and JavaScript objects. Compared to @material/animation, Anime.js offers a more extensive set of features and greater flexibility for complex animations.

gsap

GSAP (GreenSock Animation Platform) is a robust JavaScript library for high-performance animations. It is widely used for creating complex timelines and animations with precise control. GSAP provides more advanced features and customization options compared to @material/animation, making it suitable for more intricate animation needs.

velocity-animate

Velocity is an animation engine that combines the best of jQuery and CSS transitions. It offers a rich set of features for creating smooth animations and is known for its performance. While @material/animation focuses on Material Design guidelines, Velocity provides a more general-purpose solution for web animations.

README

Animation

Material in motion is responsive and natural. Use these easing curves and duration patterns to create smooth and consistent motion.

Design & API Documentation

• Material Design guidelines: Motion

Installation

npm install @material/animation

Usage

Sass Variables

We provide timing functions which you can use with the animation or transition CSS properties

@use "@material/animation";

.my-element--animating {
  animation: foo-keyframe 175ms animation.$standard-curve-timing-function;
}

Variable	Description
$deceleration-curve-timing-function	Timing function to decelerate
$standard-curve-timing-function	Timing function to quickly accelerate and slowly decelerate
$acceleration-curve-timing-function	Timing function to accelerate
$sharp-curve-timing-function	Timing function to quickly accelerate and decelerate

The following functions create transitions given $name and the $duration. You can also specify $delay, but the default is 0ms. $name can either refer to the keyframe, or to CSS property used in transition.

@use "@material/animation";

.my-element {
  transition: animation.exit-permanent(/* $name: */ opacity, /* $duration: */ 175ms, /* $delay: */ 150ms);
  opacity: 0;
  will-change: opacity;

  &--animating {
    transition: animation.enter(/* $name: */ opacity, /* $duration: */ 175ms);
    opacity: 1;
  }
}

@use "@material/animation";

@keyframes fade-in {
  from {
    transform: translateY(-80px);
    opacity: 0;
  }

  to {
    transform: translateY(0);
    opacity: 1;
  }
}

.my-element {
  animation: animation.enter(/* $name: */ fade-in, /* $duration: */ 350ms);
}

Function	Description
enter($name, $duration, $delay)	Defines transition for entering the frame
exit-permanent($name, $duration, $delay)	Defines transition for exiting the frame permanently
exit-temporary($name, $duration, $delay)	Defines transition for exiting the frame temporarily

JavaScript

These functions handle prefixing across various browsers

import {getCorrectEventName} from '@material/animation';

const eventToListenFor = getCorrectEventName(window, 'animationstart');

Method Signature	Description
getCorrectEventName(windowObj: Window, eventType: StandardJsEventType) => StandardJsEventType | PrefixedJsEventType	Returns a JavaScript event name, prefixed if necessary. See types.ts for supported values.
getCorrectPropertyName(windowObj: Window, cssProperty: StandardCssPropertyName) => StandardCssPropertyName | PrefixedCssPropertyName	Returns a CSS property name, prefixed if necessary. See types.ts for supported values.