Skip to content

Commit 8a5364d

Browse files
kirillzyuskohirbod
andauthored
docs: new video in readme (#935)
## 📜 Description Update README to make it easier-to-read. ## 💡 Motivation and Context The old README was created 3 years ago. Back to times the website didn't have brand specific colors and old video had a lot of downsides: visible mac cursor, desynchronizsed animation on Android, inconsistent UI on iOS/Android etc. I wanted to re-work the README for a long time, and now this time has came 😊 I added a better video (see changelog below), re-structured layout, re-phrased slogan etc. Overall I think new version looks much-much better 😎 ## 📢 Changelog <!-- High level overview of important changes --> <!-- For example: fixed status bar manipulation; added new types declarations; --> <!-- If your changes don't affect one of platform/language below - then remove this platform/language --> ### Video - uses brand colors - don't have "header" - uses translucent status bar on Android (identical to iOS) - fixed Android desynzchronized animation - smaller video size - video doesn't take 50% of screen width - messages don't include text, so it doesn't distract user - videos are framed in iPhone/Android skins for easier OS distinguishing ### Docs - re-arrange features and video in the same container (text from left, video from right) - change h2 to h3 to avoid auto-"hr" lines - use emoji in the beginning of each item - keep `.gif` to make sure that old demo is still shown on `npm` - re-phrase key features (thanks @hirbod) - change intro/library slogan ### CI - exclude `.apng` (`demo.png`) from being compressed; ## 🤔 How Has This Been Tested? Tested via GH preview. ## 📸 Screenshots (if appropriate): <img width="917" alt="image" src="https://github.com/user-attachments/assets/ebc603d5-90a2-4f0c-a3be-8dc0db176ff6" /> ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed --------- Co-authored-by: Hirbod <[email protected]>
1 parent 96736ef commit 8a5364d

File tree

3 files changed

+25
-24
lines changed

3 files changed

+25
-24
lines changed

.github/workflows/compress-images.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
# The `GITHUB_TOKEN` is automatically generated by GitHub and scoped only to the repository that is currently running the action. By default, the action can’t update Pull Requests initiated from forked repositories.
2727
# See https://docs.github.com/en/actions/reference/authentication-in-a-workflow and https://help.github.com/en/articles/virtual-environments-for-github-actions#token-permissions
2828
githubToken: ${{ secrets.GITHUB_TOKEN }}
29-
ignorePaths: "e2e/**"
29+
ignorePaths: "e2e/**,gifs/demo.png"
3030
jpegQuality: "80"
3131
jpegProgressive: false
3232
pngQuality: "80"

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,38 @@
11
# react-native-keyboard-controller
22

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.
44

5-
## Demonstration
5+
<div>
6+
<img align="right" width="32%" src="./gifs/demo.png?raw=true">
7+
</div>
68

7-
<img src="./gifs/demo.gif?raw=true" width="60%">
9+
### Key features
810

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! 😊
1022

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
2224

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.
2426

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
2628

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/)
2831

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
3033

31-
## Contributing
34+
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repo and development workflow.
3235

33-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
34-
35-
## License
36+
### License
3637

3738
MIT

gifs/demo.png

4.04 MB
Loading

0 commit comments

Comments
 (0)