react-web-animation
Version:
react-web-animation is a set of React components that expose the Web Animations API in a declarative way.
110 lines (81 loc) • 4.28 kB
Markdown
# react-web-animation
react-web-animation is a set of React components that expose the Web Animations API
in a declarative way.
<p align="center">
<img src="https://github.com/RinconStrategies/react-web-animation/blob/master/react_gif.gif" />
</p>
[](https://travis-ci.org/bringking/react-web-animation)
[](https://www.npmjs.com/package/react-web-animation)
[](https://www.npmjs.com/package/react-web-animation)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
## Demos
Check out how you can use it here - [http://react-web-animation.surge.sh](http://react-web-animation.surge.sh)
## Why?
Why use this over other animation libraries for React? react-web-animation uses the Web Animations API polyfill so
eventually it will use the native browser implementation and not depend on any third-party animation frameworks or CSS.
Chrome has the greatest support for these today and if you view the source on the demos, you can see it isn't using CSS at all!
## Web Animations API
Want to know more about the Web Animations API? Here are some great resources.
- [Offical Spec](https://w3c.github.io/web-animations/)
- [Polyfill](https://github.com/web-animations/web-animations-js)
- [Blog Series by Daniel Wilson](http://danielcwilson.com/blog/2015/07/animations-intro/)
## Installation
react-web-animation requires the following peer dependencies to be installed
```bash
npm install react
npm install react-dom
npm install prop-types
```
```bash
npm install react-web-animation
```
react-web-animation has a runtime dependency on the `next` version [Web Animations API](https://github.com/web-animations/web-animations-js) polyfill.
The easiest way to get this is to grab it from [cdnjs](https://cdnjs.cloudflare.com/ajax/libs/web-animations/2.2.1/web-animations-next.min.js)
and include it in your application.
```html
<script src="https://cdnjs.cloudflare.com/ajax/libs/web-animations/2.2.1/web-animations-next.min.js"></script>
```
## Features
* Animate Single Elements with a `<Animated.[componentName]>` e.g. `<Animated.div>` and control play state (play, pause, stop, reverse)
* Animate Single Elements with a `<Animation>` and control play state (play, pause, stop, reverse)
* Animate Multiple animations in parallel with a `<AnimationGroup>`, controlling them with one timeline
* Animate Multiple animations serially with a `<AnimationSequence>`, controlling them with one timeline
## Usage
Creating an animated element is as simple using an `<Animated.[elementName]>` component and supplying `keyframes` and a `timing` config.
```jsx
import React, { Component } from 'react';
import { Animated } from 'react-web-animation';
export default class Basic extends Component {
getKeyFrames() {
return [
{ transform: 'scale(1)', opacity: 1, offset: 0 },
{ transform: 'scale(.5)', opacity: 0.5, offset: 0.3 },
{ transform: 'scale(.667)', opacity: 0.667, offset: 0.7875 },
{ transform: 'scale(.6)', opacity: 0.6, offset: 1 }
];
}
getTiming( duration ) {
return {
duration,
easing: 'ease-in-out',
delay: 0,
iterations: 2,
direction: 'alternate',
fill: 'forwards'
};
}
render() {
return
<Animated.div keyframes={this.getKeyFrames()}
timing={this.getTiming(2500)}>
Web Animations API Rocks
</Animated.div>;
}
}
```
### Advanced Usage
For more advanced usage, head over to the source [documentation](https://github.com/RinconStrategies/react-web-animation/tree/master/src) or
check out the [http://react-web-animation.surge.sh](http://react-web-animation.surge.sh)
## License
MIT