easing-animation-frames
Advanced tools
- Version published
- Maintainers
- 1
- Weekly downloads
- 950
- decreased by-9.78%
Weekly downloads
Readme
Easing Animation Frames
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.
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.
The template function also provides stop and resume functions, if you want to stop the animation before it completes and resume it.
Browser Support
It uses requestAnimationFrame, which should be supported for most of the modern browsers.
FAQs
Lightweight library for creating animation
The npm package easing-animation-frames receives a total of 868 weekly downloads. As such, easing-animation-frames popularity was classified as not popular.
We found that easing-animation-frames demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.