Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 2.74 KB

File metadata and controls

71 lines (47 loc) · 2.74 KB

@tareq0065/rn-keyboard-avoiding-scroll-view

npm version CircleCI Status license: MIT Supports Android and iOS code style: prettier semantic-release

React Native ScrollView extension that prevents inputs from being covered by the keyboard.

Getting started

$ npm install @tareq0065/rn-keyboard-avoiding-scroll-view --save

Usage

Import KeyboardAvoidingScrollView, KeyboardAvoidingFlatList, or KeyboardAvoidingSectionList and use them like the regular ScrollView, FlatList or SectionList components from React Native core. Internally, these components are wrapped in another custom component called KeyboardAvoidingContainer, which is also exported for advanced use cases.

import {KeyboardAvoidingScrollView} from 'react-native-keyboard-avoiding-scroll-view';

function MyComponent() {
  return (
    <KeyboardAvoidingScrollView stickyFooter={<Button />}>
      <TextInput />
      <TextInput />
      <TextInput />
    </KeyboardAvoidingScrollView>
  )
}

Props


Reference

Props

stickyFooter

Used to display a fixed view under the scrollable content. Sticky footer is always shown above the keyboard, which could, for example, be the desired behaviour for a submit button.

Type Required
React.ReactNode No

containerStyle

Used to style the container component.

Type Required
StyleProp<ViewStyle> No

License

MIT License © Alka, Inc