UNPKG

2.25 kBMarkdownView Raw
1<p align="center">
2 <h1 align="center">React Native Gesture Handler</h1>
3 <h3 align="center">Declarative API exposing platform native touch and gesture system to React Native.</h3>
4</p>
5
6React Native Gesture Handler provides native-driven gesture management APIs for building best possible touch-based experiences in React Native.
7
8With this library gestures are no longer controlled by the JS responder system, but instead are recognized and tracked in the UI thread.
9It makes touch interactions and gesture tracking not only smooth, but also dependable and deterministic.
10
11## Installation
12
13Check [getting started](https://docs.swmansion.com/react-native-gesture-handler/docs/#installation) section of our docs for the detailed installation instructions.
14
15## Documentation
16
17Check out our dedicated documentation page for info about this library, API reference and more: [https://docs.swmansion.com/react-native-gesture-handler/docs/](https://docs.swmansion.com/react-native-gesture-handler/docs/)
18
19## Examples
20
21If 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:
22
23```bash
24 yarn install
25```
26
27If you are running on ios, run `pod install` in the ios folder
28
29Run `yarn start` to start the metro bundler
30
31Run `react-native run-android` or `react-native run-ios` (depending on which platform you want to run the example app on).
32
33You will need to have an Android or iOS device or emulator connected as well as `react-native-cli` package installed globally.
34
35## React native Support
36
37| version | react-native version |
38| ------- | -------------------- |
39| 1.4.0+ | 0.60.0+ |
40| 1.1.0+ | 0.57.2+ |
41| <1.1.0 | 0.50.0+ |
42
43## License
44
45Gesture handler library is licensed under [The MIT License](LICENSE).
46
47## Credits
48
49This project is supported by amazing people from [Expo.io](https://expo.io) and [Software Mansion](https://swmansion.com)
50
51[![expo](https://avatars2.githubusercontent.com/u/12504344?v=3&s=100 'Expo.io')](https://expo.io)
52[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-gesture-handler-github 'Software Mansion')](https://swmansion.com)
53
\No newline at end of file