mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Héctor RamosandFacebook Github Bot
9ec9567390
Differential Revision: D6261799 fbshipit-source-id: 269e151c5d136c1d508d9f2a060c0c670d0fe0f2
108 lines
1.6 KiB
Markdown
108 lines
1.6 KiB
Markdown
---
|
|
id: keyboardavoidingview
|
|
title: KeyboardAvoidingView
|
|
layout: docs
|
|
category: components
|
|
permalink: docs/keyboardavoidingview.html
|
|
next: listview
|
|
previous: 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...](docs/viewproptypes.html#props)
|
|
- [`keyboardVerticalOffset`](docs/keyboardavoidingview.html#keyboardverticaloffset)
|
|
- [`behavior`](docs/keyboardavoidingview.html#behavior)
|
|
- [`contentContainerStyle`](docs/keyboardavoidingview.html#contentcontainerstyle)
|
|
|
|
|
|
|
|
|
|
### Methods
|
|
|
|
- [`relativeKeyboardHeight`](docs/keyboardavoidingview.html#relativekeyboardheight)
|
|
- [`onKeyboardChange`](docs/keyboardavoidingview.html#onkeyboardchange)
|
|
- [`onLayout`](docs/keyboardavoidingview.html#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()`
|
|
|
|
```javascript
|
|
relativeKeyboardHeight(keyboardFrame: object):
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
### `onKeyboardChange()`
|
|
|
|
```javascript
|
|
onKeyboardChange(event: object)
|
|
```
|
|
|
|
|
|
|
|
---
|
|
|
|
### `onLayout()`
|
|
|
|
```javascript
|
|
onLayout(event: ViewLayoutEvent)
|
|
```
|
|
|
|
|
|
|