react-native/docs/keyboardavoidingview.md

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

• ViewPropTypes props...
• keyboardVerticalOffset
• behavior
• contentContainerStyle

Methods

• relativeKeyboardHeight
• onKeyboardChange
• onLayout

---

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)