0.1.1 • Published 3 years ago

react-native-use-input-scroll-handler v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

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.

OptionTypeDescription
refMutableRefObjectUse this if you need to use your own scroll view ref.
extraScrollHeightnumberAdds an extra offset to the keyboard. Useful if you want to stick elements above the keyboard.
keyboardOpeningTimenumberSets 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