Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Faradey27/react-native-keyboard-tools

A list of components and tools that help to work with the keyboard in react-native.
https://github.com/Faradey27/react-native-keyboard-tools

Last synced: 8 days ago
JSON representation

A list of components and tools that help to work with the keyboard in react-native.

Host: GitHub
URL: https://github.com/Faradey27/react-native-keyboard-tools
Owner: Faradey27
License: mit
Created: 2021-06-09T20:51:24.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-08-07T12:36:33.000Z (over 3 years ago)
Last Synced: 2024-10-28T00:03:46.947Z (16 days ago)
Language: TypeScript
Size: 2.16 MB
Stars: 24
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome - react-native-keyboard-tools - ⌨️ A list of components and tools that help to work with the keyboard in react-native. (Uncategorized / Uncategorized)

README

        # react-native-keyboard-tools

> Typesafe way to work with keyboard

![platforms](https://img.shields.io/badge/platforms-Android%20%7C%20iOS-brightgreen.svg?style=flat-square&colorB=191A17)

[![npm](https://img.shields.io/npm/v/react-native-keyboard-tools.svg?style=flat-square)](https://www.npmjs.com/package/react-native-keyboard-tools)

[![npm](https://img.shields.io/npm/dm/react-native-keyboard-tools.svg?style=flat-square&colorB=007ec6)](https://www.npmjs.com/package/react-native-keyboard-tools)

[![github issues](https://img.shields.io/github/issues/faradey27/react-native-keyboard-tools.svg?style=flat-square)](https://github.com/faradey27/react-native-keyboard-tools/issues)

[![github closed issues](https://img.shields.io/github/issues-closed/faradey27/react-native-keyboard-tools.svg?style=flat-square&colorB=44cc11)](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

![](demo.gif)

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