KeyboardAwareScrollView


Solves the very common
React Native problem of software keyboard popping over focused text input and tries to do it accurate and smooth (even on Android).
Following focused input when keyboard is already open is also supported. Internally KeyboardAwareScrollView uses
ScrollView,
UIManager and
Animated to position an input in the field of view.

Features

- Accurate positioning
- Smooth animation
- Works both on iOS and Android
- Small and simple code

Installation

Using yarn

``bash
yarn add @pietile-native-kit/keyboard-aware-scrollview
`

or using npm

`bash
npm install -S @pietile-native-kit/keyboard-aware-scrollview
`

Usage

Just put the content with inputs in KeyboardAwareScrollView and that's it.

List of specific KeyboardAwareScrollView props and methods is available below.
Everything else is passing to underlying ScrollView.

Example

`jsx
import React from 'react';

import { TextInput, Text } from 'react-native';
import { KeyboardAwareScrollView } from '@pietile-native-kit/keyboard-aware-scrollview';

function KeyboardAwareScrollViewExample() {
return (

KeyboardAwareScrollview


);
}
`

How to use with FlatList or SectionList?

Just pass renderScrollComponent props to list like below in example.

`jsx
import React, { useCallback } from 'react';

import KeyboardAwareScrollView from '@pietile-native-kit/keyboard-aware-scrollview';
import { FlatList } from 'react-native';

const ScrollComponent = React.forwardRef((forwardedProps, ref) => (

));

function KeyboardAwareFlatList(props) {
const renderScrollComponent = useCallback((scrollProps) => {
return ;
}, []);

return ;
}
``

API

$3

| name | description | type | default |
| :--------------------------------- | :--------------------------------------------------------------------------------------------------------- | -----: | :------ |
| children | Content | Node | - |
| contentContainerStyle | Style of container that wraps children and used to adjust bottom padding to keyboard | style | - |
| contentContainerStyleKeyboardShown | Style that applied to contentContainerStyle when keyboard is shown | style | - |
| extraHeight | Additional height between keyboard and focused input | number | 24 |
| scrollViewContentContainerStyle | See contentContainerStyle | style | - |
| scrollViewRef | Ref to underlying ScrollView | ref | - |

$3

| name | description |
| :------------------- | :-------------- |
| scrollToInput(input) | Scroll to input |

Acknowledge

Inspired by react-native-keyboard-aware-scroll-view and KeyboardAvoidingView

License

Pietile KeyboardAwareScrollView is MIT License.