Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyan33/react-animation-wrapper
:crystal_ball: Components animation wrapper done right
https://github.com/cyan33/react-animation-wrapper
animation css react react-components-wrapper
Last synced: 3 months ago
JSON representation
:crystal_ball: Components animation wrapper done right
- Host: GitHub
- URL: https://github.com/cyan33/react-animation-wrapper
- Owner: cyan33
- License: mit
- Created: 2017-12-30T14:41:22.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-03-07T21:26:15.000Z (almost 7 years ago)
- Last Synced: 2024-04-14T07:21:35.198Z (10 months ago)
- Topics: animation, css, react, react-components-wrapper
- Language: JavaScript
- Homepage: https://cyan33.github.io/react-animation-wrapper/
- Size: 325 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-animation-wrapper
A declarative set of react components wrapper to bring in animation, like animate.css.
Check the demo page [here](https://cyan33.github.io/react-animation-wrapper/)
## Why Another Animate.css
Compared to animate.css, react-animation-wrapper has many uncomparable advantages:
* 📦 Extremely light-weight: **6kb** (uglified) vs **72kb** (animate.css)
* 🙅 No global CSS variable polution (css in js).
* ✂️ Much More configurable and customizable via JavaScript and React.
## Usage
```sh
npm install --save react-animation-wrapper
```
Write a custom, normal react component:
```js
const Header = () =>
Hello World
```
Wrap it up with the name of the animation wrapper: **(Check out all the available ones in the [demo page](https://cyan33.github.io/react-animation-wrapper/)!)**
```js
import { BounceIn } from 'react-animation-wrapper'
ReactDOM.render(
,
document.querySelector('.root')
)
```
You are all set!
Animations available:
| WrapperName | | |
| ------------- | ------------- | ----- |
| Bounce | Flash | Pulse |
| Shake | RubberBand | Swing |
| Jello | Wobble | FadeIn |
| Tada | Bounce | Flip |
| ZoomIn | ZoomOut | JackInTheBox |
| RotateIn | RollIn | |
Check the demo page [here](https://cyan33.github.io/react-animation-wrapper/) to see what they look like.
## CHANGELOG
### `v0.1.0`
add 17 animations presets
### `v0.2.0`
expose `createAnimationWrapper` for customzied animation and could configure the animation properties (`delay`, `iterationCount`, `delay`) via passing props into the animation wrapper component
## FAQ
### Why is my animation acting weird, not as expected
The most possible reason is that you didn't specify the size and alignment of the container box of the content. This leads to the issue where your CONTAINER BOX is being animated, rather than its content. Make sure your content size is the same as its container.
### Why there appears a scroll bar in the middle of the animation
Due to different OS, browser and animations that transform its shape during the animation, it's likely that it goes beyond its container box, which then shows up a scroll bar. A quick fix: add `overflow: hidden` in the container box of the wrapper component.
## Contribution
This project is in a sense very beginner-friendly project for those who want to get some fun of open source. It's well modularized, and the logic of each components is quite easy and similar to each other.
See the issues with the `good first issue` tag and I welcome all kinds of support and can provide some guide.