{"id":13561287,"url":"https://github.com/Faradey27/react-native-keyboard-tools","last_synced_at":"2025-04-03T17:30:35.586Z","repository":{"id":57338024,"uuid":"375486172","full_name":"Faradey27/react-native-keyboard-tools","owner":"Faradey27","description":"A list of components and tools that help to work with the keyboard in react-native.","archived":false,"fork":false,"pushed_at":"2021-08-07T12:36:33.000Z","size":2264,"stargazers_count":24,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T04:51:10.914Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Faradey27.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-09T20:51:24.000Z","updated_at":"2024-09-24T15:44:31.000Z","dependencies_parsed_at":"2022-09-12T10:00:23.216Z","dependency_job_id":null,"html_url":"https://github.com/Faradey27/react-native-keyboard-tools","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Faradey27%2Freact-native-keyboard-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Faradey27%2Freact-native-keyboard-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Faradey27%2Freact-native-keyboard-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Faradey27%2Freact-native-keyboard-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Faradey27","download_url":"https://codeload.github.com/Faradey27/react-native-keyboard-tools/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247046745,"owners_count":20874714,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:00:54.489Z","updated_at":"2025-04-03T17:30:34.766Z","avatar_url":"https://github.com/Faradey27.png","language":"TypeScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# react-native-keyboard-tools\n\u003e Typesafe way to work with keyboard\n\n![platforms](https://img.shields.io/badge/platforms-Android%20%7C%20iOS-brightgreen.svg?style=flat-square\u0026colorB=191A17)\n[![npm](https://img.shields.io/npm/v/react-native-keyboard-tools.svg?style=flat-square)](https://www.npmjs.com/package/react-native-keyboard-tools)\n[![npm](https://img.shields.io/npm/dm/react-native-keyboard-tools.svg?style=flat-square\u0026colorB=007ec6)](https://www.npmjs.com/package/react-native-keyboard-tools)\n\u003c!-- [![github release](https://img.shields.io/github/release/faradey27/react-native-keyboard-tools.svg?style=flat-square)](https://github.com/faradey27/react-native-keyboard-tools/releases) --\u003e\n[![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)\n[![github closed issues](https://img.shields.io/github/issues-closed/faradey27/react-native-keyboard-tools.svg?style=flat-square\u0026colorB=44cc11)](https://github.com/faradey27/react-native-keyboard-tools/issues?q=is%3Aissue+is%3Aclosed)\n\n-----\n\n## Table of contents\n\n  - [Showcase](#showcase)\n  - [Usage](#usage)\n    - [KeyboardAwareScrollView](#keyboardawarescrollview)\n    - [useMaskedTextInput](#usemaskedtextinput)\n    - [KeyboardAwareScrollView and useMaskedTextInput](#keyboardawarescrollview-and-usemaskedtextinput)\n  - [KeyboardAwareScrollView props and methods](#keyboardawarescrollview-props-and-methods)\n    - [Props](#props)\n    - [Methods](#methods)\n  - [useMaskedTextInput params](#usemaskedtextinput-params)\n  - [Credits](#credits)\n  - [License](#license)\n  - [Author](#author)\n\n-----\n\n## Showcase\n\n![](demo.gif)\n\n[Expo Playground](https://snack.expo.io/@andriitiertyshnyi/blessed-donuts)\n\n-----\n\n## Usage\n\n```bash\n$ npm install --save react-native-keyboard-tools\n```\n\nor\n\n```bash\n$ yarn add react-native-keyboard-tools\n```\n\n### KeyboardAwareScrollView\n\n```jsx\nimport { View, TextInput } from 'react-native'\nimport { KeyboardAwareScrollView } from 'react-native-keyboard-tools'\n\nexport const MyComponent = () =\u003e {\n  return (\n    \u003cKeyboardAwareScrollView\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n    \u003c/KeyboardAwareScrollView\u003e\n  )\n}\n```\n\n### useMaskedTextInput\n\n```jsx\nimport { useState } from 'react'\nimport { View, TextInput } from 'react-native'\nimport { useMaskedTextInput } from 'react-native-keyboard-tools'\n\nexport const MyComponent = () =\u003e {\n  const [value, setValue] = useState(\"\");\n  const { onChangeMaskedText } = useMaskedTextInput({ mask: \"+3(99) 9999 9999\", onChangeText: setValue });\n\n  return \u003cTextInput onChangeText={onChangeMaskedText} /\u003e\n}\n```\n\n### KeyboardAwareScrollView and useMaskedTextInput\n\n```jsx\nimport { View, TextInput } from 'react-native'\nimport { KeyboardAwareScrollView, useMaskedTextInput } from 'react-native-keyboard-tools'\n\nexport const MyComponent = () =\u003e {\n  const [value, setValue] = useState(\"\");\n  const { onChangeMaskedText } = useMaskedTextInput({ mask: \"+3(99) 9999 9999\", onChangeText: setValue });\n\n  return (\n    \u003cKeyboardAwareScrollView\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput onChangeText={onChangeMaskedText} /\u003e\n      \u003c/View\u003e\n    \u003c/KeyboardAwareScrollView\u003e\n  )\n}\n```\n\n-----\n\n## KeyboardAwareScrollView props and methods\n\n### Props\n\nProp | Description | Type | Default\n------ | ------ | ------ | ------\n**`children`** | Any react node | ReactNode | **Required**\n**`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\n**`restoreScrollOnKeyboardHide`** | Controls whether library should restore scroll position to the initial value after keyboard become hidden | Boolean | false\n\nAny react-native ScrollView props are also accepted([ScrollViewProps](https://reactnative.dev/docs/scrollview#props))\n\n### Methods\n\n```jsx\nimport { View, TextInput } from 'react-native'\nimport { KeyboardAwareScrollView, KeyboardAwareScrollViewRef } from 'react-native-keyboard-tools'\n\nexport const MyComponent = () =\u003e {\n  const scrollViewRef = useRef\u003cKeyboardAwareScrollViewRef\u003e();\n\n  return (\n    \u003cKeyboardAwareScrollView ref={scrollViewRef}\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput /\u003e\n      \u003c/View\u003e\n      \u003cView\u003e\n        \u003cTextInput onChangeText={onChangeMaskedText} /\u003e\n      \u003c/View\u003e\n    \u003c/KeyboardAwareScrollView\u003e\n  )\n}\n```\n\nscrollViewRef.scrollTo: `({ x, y, animated }: { x?: number; y?: number; animated?: boolean }) =\u003e void`\n\n-----\n\n## useMaskedTextInput params\n\n```js\nconst { onChangeMaskedText } = useMaskedTextInput({ mask, onChangeText });\n```\n\nmask: `defined by pattern`\n\n* `9` - accept digit.\n* `A` - accept alpha.\n* `S` - accept alphanumeric.\n* `*` - accept all, EXCEPT white space.\n\nExample: `AAA-9999` \n\nonChangeText: `(value: string) =\u003e void`\n\nonChangeMaskedText: `(value: string, rawValue: string) =\u003e void`\n\n-----\n\n## Credits\n\nInspired by https://github.com/wix/react-native-keyboard-aware-scrollview and https://github.com/benhurott/react-native-masked-text\n\n## License\n\n[MIT.](LICENSE.md)\n\n## Author\n\n[Andrii Tiertyshnyi](https://www.linkedin.com/in/atiertyshnyi/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFaradey27%2Freact-native-keyboard-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFaradey27%2Freact-native-keyboard-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFaradey27%2Freact-native-keyboard-tools/lists"}