1 | <p align="center">
|
2 | <h1 align="center">React Native Reanimated</h1>
|
3 | <h3 align="center">React Native's Animated library reimplemented</h3>
|
4 | </p>
|
5 |
|
6 | React Native Reanimated provides a more comprehensive,
|
7 | low level abstraction for the Animated library API to be built
|
8 | on top of and hence allow for much greater flexibility especially when it
|
9 | comes to gesture based interactions.
|
10 |
|
11 | ## Installation
|
12 |
|
13 | Check [getting started](https://software-mansion.github.io/react-native-reanimated/getting-started.html) section of our docs for the detailed installation instructions.
|
14 |
|
15 | ## Documentation
|
16 |
|
17 | Check out our dedicated documentation page for info about this library, API reference and more: [https://software-mansion.github.io/react-native-reanimated](https://software-mansion.github.io/react-native-reanimated)
|
18 |
|
19 | ## Examples
|
20 |
|
21 | The source code for the example (showcase) app is under the [`Example/`](https://github.com/software-mansion/react-native-reanimated/blob/master/Example/) directory.
|
22 | If you want to play with the API but don't feel like trying it on a real app, you can run the example project. Clone the repo, go to the Example/ folder and run:
|
23 |
|
24 | ```
|
25 | yarn install
|
26 | ```
|
27 |
|
28 | ### Running on iOS
|
29 |
|
30 | Before running the app, install the cocoapods dependencies:
|
31 |
|
32 | ```
|
33 | cd ios && pod install && cd ..
|
34 | ```
|
35 |
|
36 | Now, you can start the app:
|
37 |
|
38 | ```
|
39 | react-native run-ios
|
40 | ```
|
41 |
|
42 | ### Running on Android
|
43 |
|
44 | Run the react native's cli command:
|
45 |
|
46 | ```
|
47 | react-native run-android
|
48 | ```
|
49 |
|
50 | **Important:** You will need to have an Android or iOS device or emulator connected as well as react-native-cli package installed globally.
|
51 |
|
52 | ## License
|
53 |
|
54 | Reanimated library is licensed under [The MIT License](LICENSE).
|
55 |
|
56 | ## Credits
|
57 |
|
58 | This project is supported by amazing people from [Expo.io](https://expo.io) and [Software Mansion](https://swmansion.com)
|
59 |
|
60 | [![expo](https://avatars2.githubusercontent.com/u/12504344?v=3&s=100 'Expo.io')](https://expo.io)
|
61 | [![swm](https://avatars0.githubusercontent.com/u/56880679?v=3&s=100 'Software Mansion')](https://swmansion.com)
|