Giter VIP home page Giter VIP logo

easing-animation-frames's Introduction

Easing Animation Frames

Build Status

npm i easing-animation-frames

This is a tiny library for creating CPU-friendly easing animations with requestAnimationFrame API and Robert Penner's easing equations. Suggestions and pull requests for optimization are welcome.

Bar Animation

How to use

Select an easing type (cubicInOut by default) and pass a callback function to run for every animation frame which manipulates target DOM elements.

Minimum settings

// Template function
const updateBarWidth = ({ progress }) => {
  // Update the DOM with the progress value
}

easingAnimationFrames({
  template: updateBarWidth // Callback function to run for every frame, which receives progress from 0 to 1
});

With optional settings

// Template function
const updateBarWidth = ({
  progress,
  stopFrames, // Stops the animation
  resumeFrames, // Resumes the animation
  restartFrames, // Restarts the animation
}) => {
  // Update the DOM with the progress value
}

easingAnimationFrames({
  easingType: "quadInOut", // Easing function name
  duration: 3000, // Animation duration in milliseconds
  template: updateBarWidth, // Callback function to run for every frame, which receives progress from 0 to 1
  complete: animationComplete, // Callback funciton to run on completion
});

Duration is set to be 4,000 milliseconds by default, which you can change. Once the animation starts, the callback function (template) receives the progress value (from 0 to 1) that you can use to render the animation. The example above uses (progress * 75)% for the width of the bar, based on the time passed.

npm start to see the example (Node v10.15.1+).

The template function also provides stop and resume functions, if you want to stop the animation before it completes and resume it.

React Easing Animation is a React HOC implementation of this library.

Browser Support

It uses requestAnimationFrame, which should be supported for most of the modern browsers.

easing-animation-frames's People

Contributors

prinzdezibel avatar taisuke-j avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.