react-native/docs/keyboardavoidingview.md
Héctor Ramos e11d496e9d Additional markdown adjustments
Summary:
Follow up to 9ec95673909beac7798f589e0e9821b4225f8fa9
Closes https://github.com/facebook/react-native/pull/16759

Differential Revision: D6285219

Pulled By: hramos

fbshipit-source-id: 7012d257a5a6cff06cb2d94203a9379e4b7e3c4e
2017-11-09 09:55:05 -08:00

1.7 KiB

id title layout category permalink next previous
keyboardavoidingview KeyboardAvoidingView docs components docs/keyboardavoidingview.html listview image

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 position or bottom padding based on the position of the keyboard.

Props

Methods


Reference

Props

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.

Type Required
number Yes

behavior

Type Required
enum('height', 'position', 'padding') No

contentContainerStyle

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

Type Required
ViewPropTypes.style No

Methods

relativeKeyboardHeight()

relativeKeyboardHeight(keyboardFrame: object): 

onKeyboardChange()

onKeyboardChange(event: object)

onLayout()

onLayout(event: ViewLayoutEvent)