Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mateusz1913/react-native-avoid-softinput
Native solution for common React Native problem of focused views being covered by soft input view.
https://github.com/mateusz1913/react-native-avoid-softinput
android ios keyboard react-native softinput
Last synced: 3 days ago
JSON representation
Native solution for common React Native problem of focused views being covered by soft input view.
- Host: GitHub
- URL: https://github.com/mateusz1913/react-native-avoid-softinput
- Owner: mateusz1913
- License: mit
- Created: 2021-07-02T21:27:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T19:17:27.000Z (19 days ago)
- Last Synced: 2024-11-06T13:00:35.034Z (7 days ago)
- Topics: android, ios, keyboard, react-native, softinput
- Language: TypeScript
- Homepage: https://mateusz1913.github.io/react-native-avoid-softinput/
- Size: 11.1 MB
- Stars: 703
- Watchers: 5
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# `react-native-avoid-softinput`
Handle keyboard in React Native apps like a Pro
Native solution for common React Native problem of focused views being covered by soft input view. It is solved by listening for soft input events and applying translation to react root view (or bottom padding if focused element's parent is scroll view) entirely on native side and only if currently focused view is covered by soft input frame. It supports focused views being positioned in scroll views and regular views (check out example app). It also supports modal content, when content is wrapped in [AvoidSoftInputView](https://mateusz1913.github.io/react-native-avoid-softinput/docs/api/view/).
## Documentation
Check package [documentation](https://mateusz1913.github.io/react-native-avoid-softinput/)
## Support
This library follows the React Native [releases support policy](https://github.com/reactwg/react-native-releases#releases-support-policy).
It is supporting **the latest version**, and **the two previous minor series**.
You may find it working correctly with some older React Native versions, but it'll be a "Use at your own risk" case.
This library supports "New Architecture".
## Installation
Library supports Android & iOS, for out-of-tree platforms, `View` component is used as fallback.
1. Install library with your package manager:
```sh
yarn add react-native-avoid-softinput
```
or
```sh
npm i --save react-native-avoid-softinput
```
2. (iOS-only) Install pods:
```sh
npx pod-install
```
For reference, you can visit [Getting started](https://mateusz1913.github.io/react-native-avoid-softinput/docs/guides/) section
## Expo
- ✅ You can use this library with [Development Builds](https://docs.expo.dev/development/introduction/). No config plugin is required.
- ❌ This library can't be used in the "Expo Go" app because it [requires custom native code](https://docs.expo.dev/workflow/customizing/).
## Usage
Check usage guides for [module](https://mateusz1913.github.io/react-native-avoid-softinput/docs/guides/usage-module) and [view](https://mateusz1913.github.io/react-native-avoid-softinput/docs/guides/usage-view)
## Alternatives
If library does not suite your needs, you can check [alternatives section](https://mateusz1913.github.io/react-native-avoid-softinput/docs/guides/alternatives)
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT