@teambuildr/react-native-use-input-scroll-handler
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

react-native-use-input-scroll-handler

A react-native hook that handle auto-scroll when input is focused and behind keyboard.

Installation

yarn add react-native-use-input-scroll-handler

Usage

import useInputScrollHandler from "react-native-use-input-scroll-handler";

// ...

const { scrollHandler } = useInputScrollHandler();

<ScrollView {...scrollHandler}>

API

Custom options can be passed to this hook.

Option Type Description
ref MutableRefObject Use this if you need to use your own scroll view ref.
extraScrollHeight number Adds an extra offset to the keyboard. Useful if you want to stick elements above the keyboard.
keyboardOpeningTime number Sets the delay time before scrolling to new position, default is 250

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Package Sidebar

Install

npm i @teambuildr/react-native-use-input-scroll-handler

Weekly Downloads

2

Version

0.1.4

License

MIT

Unpacked Size

46.3 kB

Total Files

9

Last publish

Collaborators

  • sierramoore
  • jrpeters89
  • elvisguillen
  • kylemiller