|
1 | 1 | # react-native-keyboard-controller
|
2 | 2 |
|
3 |
| -Keyboard manager which works in identical way on both iOS and Android. |
| 3 | +A universal keyboard handling solution for React Native — lightweight, fully customizable, and built for real-world apps. Smooth animations, consistent behavior on both iOS and Android, with a developer-oriented design. |
4 | 4 |
|
5 |
| -## Demonstration |
| 5 | +<div> |
| 6 | + <img align="right" width="32%" src="./gifs/demo.png?raw=true"> |
| 7 | +</div> |
6 | 8 |
|
7 |
| -<img src="./gifs/demo.gif?raw=true" width="60%"> |
| 9 | +### Key features |
8 | 10 |
|
9 |
| -## Key features |
| 11 | +- 🧬 Map keyboard movement to animated values |
| 12 | +- 🧪 `keyboardWillShow` / `keyboardWillHide` events now available on Android |
| 13 | +- ⚡ Change soft input mode on Android |
| 14 | +- 🚀 Reanimated support |
| 15 | +- 📱 Interactive keyboard dismissing 👆📱 |
| 16 | +- 📚 Prebuilt components (`KeyboardStickyView`, `KeyboardAwareScrollView`, reworked `KeyboardAvoidingView`) |
| 17 | +- 📐 `KeyboardToolbar` with customizable _**previous**_, _**next**_, and _**done**_ buttons |
| 18 | +- 🌐 Display anything over the keyboard (without dismissing it) using `OverKeyboardView` |
| 19 | +- 📝 Easy retrieval of focused input info |
| 20 | +- 🧭 Compatible with any navigation library |
| 21 | +- ✨ More coming soon... stay tuned! 😊 |
10 | 22 |
|
11 |
| -- mapping keyboard movement to animated values 😎 |
12 |
| -- missing `keyboardWillShow` / `keyboardWillHide` events are available on Android 😍 |
13 |
| -- module for changing soft input mode on Android 🤔 |
14 |
| -- reanimated support 🚀 |
15 |
| -- interactive keyboard dismissing 👆📱 |
16 |
| -- prebuilt components (`KeyboardStickyView`, `KeyboardAwareScrollView`, re-worked `KeyboardAvoidingView`) 📚 |
17 |
| -- `KeyboardToolbar` with easy behavior customization of _**previous**_, _**next**_ and _**done**_ buttons in the keyboard toolbar 📐 |
18 |
| -- show anything over the keyboard (without dismissing it) using `OverKeyboardView` 🌐 |
19 |
| -- easy focused input information retrieval 📝 🔮 |
20 |
| -- works with any navigation library 🧭 |
21 |
| -- and more is coming... Stay tuned! 😊 |
| 23 | +### Installation |
22 | 24 |
|
23 |
| -## Installation |
| 25 | +Check out the [installation](https://kirillzyusko.github.io/react-native-keyboard-controller/docs/installation) section of the docs for detailed setup instructions. |
24 | 26 |
|
25 |
| -Check out the [installation](https://kirillzyusko.github.io/react-native-keyboard-controller/docs/installation) section of docs for the detailed installation instructions. |
| 27 | +### Documentation |
26 | 28 |
|
27 |
| -## Documentation |
| 29 | +Full API reference and guides available at: |
| 30 | +[https://kirillzyusko.github.io/react-native-keyboard-controller/](https://kirillzyusko.github.io/react-native-keyboard-controller/) |
28 | 31 |
|
29 |
| -Check out the dedicated documentation page for information about this library, API reference and more: [https://kirillzyusko.github.io/react-native-keyboard-controller/](https://kirillzyusko.github.io/react-native-keyboard-controller/) |
| 32 | +### Contributing |
30 | 33 |
|
31 |
| -## Contributing |
| 34 | +See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repo and development workflow. |
32 | 35 |
|
33 |
| -See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. |
34 |
| - |
35 |
| -## License |
| 36 | +### License |
36 | 37 |
|
37 | 38 | MIT
|
0 commit comments