跳到主要内容

Keyboard

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

用法示例

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


文档

方法

addListener()

tsx
static addListener: (
eventType: KeyboardEventName,
listener: KeyboardEventListener,
) => EmitterSubscription;

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

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

参数:

名称类型说明
eventName
Required
string用来指明要监听的事件,具体有以下几种:
callback
Required
function事件触发时调用的 js 函数

eventName

事件为以下几种:

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

在 Android 上,只有 keyboardDidShowkeyboardDidHide 事件可用。如果你的 activity 将 android:windowSoftInputMode 设置为 adjustResizeadjustNothing,那么在 Android 10 及以下版本中,这些事件不会触发。


dismiss()

tsx
static dismiss()

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


scheduleLayoutAnimation

tsx
static scheduleLayoutAnimation(event: KeyboardEvent);

用于将 TextInput(或其他键盘附属视图)的大小或位置变化与键盘移动同步。


isVisible()

tsx
static isVisible(): boolean;

键盘当前是否弹出可见。


metrics()

tsx
static metrics(): KeyboardMetrics | undefined;

如果当前已经弹出软键盘,返回当前软键盘的尺寸。