帮助改进此文档

Keyboard

Keyboard模块用来控制键盘相关的事件。

用法示例

Keyboard模块可以监听原生键盘事件以做出相应回应，比如收回键盘。

import React, { Component } from 'react';
import { Keyboard, TextInput } from 'react-native';

class Example extends Component {
  componentDidMount () {
    this.keyboardDidShowListener = Keyboard.addListener('keyboardDidShow', this._keyboardDidShow);
    this.keyboardDidHideListener = Keyboard.addListener('keyboardDidHide', this._keyboardDidHide);
  }

  componentWillUnmount () {
    this.keyboardDidShowListener.remove();
    this.keyboardDidHideListener.remove();
  }

  _keyboardDidShow () {
    alert('Keyboard Shown');
  }

  _keyboardDidHide () {
    alert('Keyboard Hidden');
  }

  render() {
    return (
      <TextInput
        onSubmitEditing={Keyboard.dismiss}
      />
    );
  }
}

---

文档

方法

addListener()

static addListener(eventName, callback)

addListener用于注册一个 JavaScript 函数来监听处理原生键盘通知事件。

此方法会返回监听函数的引用。

Parameters:

Name	Type	Required	Description
eventName	string	Yes	nativeEvent参数用来指明要监听的事件，具体有以下几种:
callback	function	Yes	事件触发时调用的 js 函数

nativeEvent

This can be any of the following

• keyboardWillShow
• keyboardDidShow
• keyboardWillHide
• keyboardDidHide
• keyboardWillChangeFrame
• keyboardDidChangeFrame

注意如果你把android:windowSoftInputMode设置为adjustResize或是adjustPan，则在 Android 上只有keyboardDidShow和keyboardDidHide事件有效。如果android:windowSoftInputMode设置为adjustNothing，则没有任何事件有效。keyboardWillShow as well as keyboardWillHide are generally not available on Android since there is no native corresponding event.

---

removeListener()

static removeListener(eventName, callback)

移除某个类型事件的监听函数。

Parameters:

Name	Type	Required	Description
eventName	string	Yes	要移除监听函数的原生事件类型名称
callback	function	Yes	要移除的监听函数

---

removeAllListeners()

static removeAllListeners(eventName)

移除某个类型事件的所有监听函数。

---

dismiss()

static dismiss()

把弹出的键盘收回去，同时使当前的文本框失去焦点。