# react-native-keyboard-tools
> A list of components and tools that help to work with the keyboard in react-native
Latest version **1.3.1** (published 2021-08-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install react-native-keyboard-tools
pnpm add react-native-keyboard-tools
yarn add react-native-keyboard-tools
bun add react-native-keyboard-tools
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.3.1 |
| Published | 2021-08-07 |
| First published | 2021-06-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Andrii Tiertyshnyi |
| Maintainers | faradey27 |
| Keywords | react, react-native, keyboard, text input, masked, input-mask, scrollview, KeyboardAvoidingView, react-component, hook |
## Links
- npm: https://www.npmjs.com/package/react-native-keyboard-tools
- Repository: https://github.com/Faradey27/react-native-keyboard-tools
- Homepage: https://github.com/Faradey27/react-native-keyboard-tools#readme
- Issues: https://github.com/Faradey27/react-native-keyboard-tools/issues
- npm.io page: https://npm.io/package/react-native-keyboard-tools
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 1.3.1 (latest) — 2021-08-07
- 1.3.0 — 2021-07-28
- 1.2.2 — 2021-07-18
- 1.2.1 — 2021-06-14
- 1.2.0 — 2021-06-14
- 1.1.0 — 2021-06-13
- 1.0.7 — 2021-06-10
- 1.0.6 — 2021-06-10
- 1.0.5 — 2021-06-09
- 1.0.4 — 2021-06-09
- 1.0.3 — 2021-06-09
- 1.0.2 — 2021-06-09
- 1.0.1 — 2021-06-09
- 1.0.0 — 2021-06-09
## README
# react-native-keyboard-tools
> Typesafe way to work with keyboard
[](https://www.npmjs.com/package/react-native-keyboard-tools)
[](https://www.npmjs.com/package/react-native-keyboard-tools)
[](https://github.com/faradey27/react-native-keyboard-tools/issues)
[](https://github.com/faradey27/react-native-keyboard-tools/issues?q=is%3Aissue+is%3Aclosed)
-----
## Table of contents
- [Showcase](#showcase)
- [Usage](#usage)
- [KeyboardAwareScrollView](#keyboardawarescrollview)
- [useMaskedTextInput](#usemaskedtextinput)
- [KeyboardAwareScrollView and useMaskedTextInput](#keyboardawarescrollview-and-usemaskedtextinput)
- [KeyboardAwareScrollView props and methods](#keyboardawarescrollview-props-and-methods)
- [Props](#props)
- [Methods](#methods)
- [useMaskedTextInput params](#usemaskedtextinput-params)
- [Credits](#credits)
- [License](#license)
- [Author](#author)
-----
## Showcase
[Expo Playground](https://snack.expo.io/@andriitiertyshnyi/blessed-donuts)
-----
## Usage
```bash
$ npm install --save react-native-keyboard-tools
```
or
```bash
$ yarn add react-native-keyboard-tools
```
### KeyboardAwareScrollView
```jsx
import { View, TextInput } from 'react-native'
import { KeyboardAwareScrollView } from 'react-native-keyboard-tools'
export const MyComponent = () => {
return (
)
}
```
### useMaskedTextInput
```jsx
import { useState } from 'react'
import { View, TextInput } from 'react-native'
import { useMaskedTextInput } from 'react-native-keyboard-tools'
export const MyComponent = () => {
const [value, setValue] = useState("");
const { onChangeMaskedText } = useMaskedTextInput({ mask: "+3(99) 9999 9999", onChangeText: setValue });
return
}
```
### KeyboardAwareScrollView and useMaskedTextInput
```jsx
import { View, TextInput } from 'react-native'
import { KeyboardAwareScrollView, useMaskedTextInput } from 'react-native-keyboard-tools'
export const MyComponent = () => {
const [value, setValue] = useState("");
const { onChangeMaskedText } = useMaskedTextInput({ mask: "+3(99) 9999 9999", onChangeText: setValue });
return (
)
}
```
-----
## KeyboardAwareScrollView props and methods
### Props
Prop | Description | Type | Default
------ | ------ | ------ | ------
**`children`** | Any react node | ReactNode | **Required**
**`automaticallyAdjustContentInsets`** | Controls whether OS should automatically adjust the content inset for scroll views that are placed behind a navigation bar or tab bar/toolbar. | Boolean | false
**`restoreScrollOnKeyboardHide`** | Controls whether library should restore scroll position to the initial value after keyboard become hidden | Boolean | false
Any react-native ScrollView props are also accepted([ScrollViewProps](https://reactnative.dev/docs/scrollview#props))
### Methods
```jsx
import { View, TextInput } from 'react-native'
import { KeyboardAwareScrollView, KeyboardAwareScrollViewRef } from 'react-native-keyboard-tools'
export const MyComponent = () => {
const scrollViewRef = useRef();
return (
)
}
```
scrollViewRef.scrollTo: `({ x, y, animated }: { x?: number; y?: number; animated?: boolean }) => void`
-----
## useMaskedTextInput params
```js
const { onChangeMaskedText } = useMaskedTextInput({ mask, onChangeText });
```
mask: `defined by pattern`
* `9` - accept digit.
* `A` - accept alpha.
* `S` - accept alphanumeric.
* `*` - accept all, EXCEPT white space.
Example: `AAA-9999`
onChangeText: `(value: string) => void`
onChangeMaskedText: `(value: string, rawValue: string) => void`
-----
## Credits
Inspired by https://github.com/wix/react-native-keyboard-aware-scrollview and https://github.com/benhurott/react-native-masked-text
## License
[MIT.](LICENSE.md)
## Author
[Andrii Tiertyshnyi](https://www.linkedin.com/in/atiertyshnyi/)
---
_Source: https://npm.io/package/react-native-keyboard-tools · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._