Skip to content
This repository was archived by the owner on Aug 19, 2022. It is now read-only.

Commit 9cb698a

Browse files
author
Brandon Dail
committed
Update language in README
1 parent 492ece8 commit 9cb698a

File tree

1 file changed

+93
-6
lines changed

1 file changed

+93
-6
lines changed

README.md

Lines changed: 93 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
11
# react-animations
22

33

4-
A collection of animations for CSS-in-JS libraries. react-animations implements all animations from [animate.css](https://daneden.github.io/animate.css/), allowing you to use them in any project that uses JavaScript for style management. [Check out the interactive demo](http://react-animations.herokuapp.com/).
4+
A collection of animations that can be used with any inline style library that supports using objects to define keyframe animations, such as Radium or Aphrodite. React-animations implements all animations from [animate.css](https://daneden.github.io/animate.css/).
5+
6+
[Check out the interactive demo](http://react-animations.herokuapp.com/).
7+
58
### Usage
69

7-
These animations can be used with Radium, Aphordite, or any other CSS-in-JS library that supports using objects to define keyframes. Just import the animation from the package
8-
and include it in your style definition. Below are some examples using a few
9-
popular styling libraries.
10+
You can import each animation directly from the main package
1011

12+
```js
13+
import { fadeIn } from 'react-animations'
14+
```
1115

12-
### Radium
16+
or you can import a specific animation directly
17+
18+
```js
19+
import fadeIn from 'react-animations/fadeIn'
20+
```
21+
22+
23+
### Usage with Radium
1324

1425
```js
1526
import { bounce } from 'react-animations';
@@ -23,7 +34,7 @@ const styles = {
2334
}
2435
```
2536

26-
### Aphrodite
37+
### Usage with Aphrodite
2738

2839
```js
2940
import { bounce } from 'react-animations';
@@ -42,82 +53,158 @@ const styles = StyleSheet.create({
4253
Below is a list of all available animations
4354

4455
`bouceOut`
56+
4557
`bounce`
58+
4659
`bounceIn`
60+
4761
`bounceInDown`
62+
4863
`bounceInLeft`
64+
4965
`bounceInRight`
66+
5067
`bounceInUp`
68+
5169
`bounceOutDown`
70+
5271
`bounceOutLeft`
72+
5373
`bounceOutRight`
74+
5475
`bounceOutUp`
76+
5577
`fadeIn`
78+
5679
`fadeInDown`
80+
5781
`fadeInDownBig`
82+
5883
`fadeInLeft`
84+
5985
`fadeInLeftBig`
86+
6087
`fadeInRight`
88+
6189
`fadeInRightBig`
90+
6291
`fadeInUp`
92+
6393
`fadeInUpBig`
94+
6495
`fadeOut`
96+
6597
`fadeOutDown`
98+
6699
`fadeOutDownBig`
100+
67101
`fadeOutLeft`
102+
68103
`fadeOutLeftBig`
104+
69105
`fadeOutRight`
106+
70107
`fadeOutRightBig`
108+
71109
`fadeOutUp`
110+
72111
`fadeOutUpBig`
112+
73113
`flash`
114+
74115
`flip`
116+
75117
`flipInX`
118+
76119
`flipInY`
120+
77121
`flipOutX`
122+
78123
`flipOutY`
124+
79125
`headShake`
126+
80127
`hinge`
128+
81129
`jello`
130+
82131
`lightSpeedIn`
132+
83133
`lightSpeedOut`
134+
84135
`pulse`
136+
85137
`rollIn`
138+
86139
`rollOut`
140+
87141
`rotateIn`
142+
88143
`rotateInDownLeft`
144+
89145
`rotateInDownRight`
146+
90147
`rotateInUpLeft`
148+
91149
`rotateInUpRight`
150+
92151
`rotateOut`
152+
93153
`rotateOutDownLeft`
154+
94155
`rotateOutDownRight`
156+
95157
`rotateOutUpLeft`
158+
96159
`rotateOutUpRight`
160+
97161
`rubberBand`
162+
98163
`shake`
164+
99165
`slideInDown`
166+
100167
`slideInLeft`
168+
101169
`slideInRight`
170+
102171
`slideInUp`
172+
103173
`slideOutDown`
174+
104175
`slideOutLeft`
176+
105177
`slideOutRight`
178+
106179
`slideOutUp`
180+
107181
`swing`
182+
108183
`tada`
184+
109185
`wobble`
186+
110187
`zoomIn`
188+
111189
`zoomInDown`
190+
112191
`zoomInLeft`
192+
113193
`zoomInRight`
194+
114195
`zoomInUp`
196+
115197
`zoomOut`
198+
116199
`zoomOutDown`
200+
117201
`zoomOutLeft`
202+
118203
`zoomOutRight`
204+
119205
`zoomOutUp`
120206

207+
121208
## Merge
122209

123210
react-animations also exports a `merge` function that takes two animations and returns a new animation that combines the transforms from both. This is experimental and wont work (well) with animations that have conflicting transforms, such as `fadeIn` and `fadeOut`. The merged animation can be used just like any of the imported animations.

0 commit comments

Comments
 (0)