Web Animate
A lightweight polyfill for the Web Animations API. (WAAPI)
This project aims to provide a lightweight polyfill to WAAPI that leverages CSS Keyframes and does not call requestAnimationFrame on every frame.
How to use
This library automatically polyfills on browsers without Element.prototype.animate(). There are a few functions that can be called manually however:
// force rendering of CSS keyframes immediatelyWebAnimate // call animate directlyWebAnimate // manually replaces animate()// Call only if you want to forcibly overwrite Element.prototype.animate()WebAnimate // use this to determine if the animate() has been overriddenif WebAnimate // do something
Setup
Include this in your head:
Or download with npm and import this in your entry js file:
npm i web-animate -S
Demos
Contributions
Contributions are welcome. Please create an issue prior to adding a Pull Request. See below on how to run this project locally.
How to get the project running locally
- Install NodeJS / NPM
- Clone this project
- Run
npm install
in the directory - Run
npm start
. This will build to thelib
directory and simultaneously run all test files in thetests
directory.
Alternately, run
npm run test:watch
to only watch tests, ornpm run build:watch
to only watch src files
Structure of the project
Folder | Description |
---|---|
/lib | Output for node |
/lib.es2015 | Output as ES2015 modules |
/src | Source files |
/tests | Test files |
/types | Output for TypeScript type definitions |
Before you submit a Pull Request for code
- Submit an issue
- Ensure at least one new unit test exists to cover the feature/bug
- Ensure new files are formatted property (4 space indentation)
License
This library is licensed under MIT.