Skip to main content
Version: 0.60

KeyboardAvoidingView

It is a component to solve the common problem of views that need to move out of the way of the virtual keyboard. It can automatically adjust either its height, position, or bottom padding based on the position of the keyboard.

Example usage:

import {KeyboardAvoidingView} from 'react-native';

<KeyboardAvoidingView
  style={styles.container}
  behavior="padding"
  enabled>
  ... your UI ...
</KeyboardAvoidingView>;

Example​

Reference

Props​

Inherits View Props.

behavior​

Specify how to react to the presence of the keyboard.

Note: Android and iOS both interact with this prop differently. Android may behave better when given no behavior prop at all, whereas iOS is the opposite.

TypeRequired
enum('height', 'position', 'padding')No

contentContainerStyle​

The style of the content container(View) when behavior is 'position'.

TypeRequired
View.styleNo

enabled​

Enabled or disabled KeyboardAvoidingView. The default is true.

TypeRequired
booleanNo

keyboardVerticalOffset​

This is the distance between the top of the user screen and the react native view, may be non-zero in some use cases. Defaults to 0.

TypeRequired
numberNo