跳到主要内容

Keyboard

Keyboard 模块用于控制键盘事件。

用法

Keyboard 模块允许你监听原生事件并对其做出反应,以及对键盘进行更改,例如将其关闭。


参考

方法

addListener()

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

addListener 函数将 JavaScript 函数连接到已标识的原生键盘通知事件。

此函数随后返回侦听器的引用。

参数

姓名类型描述
eventName
必需
字符串标识你正在监听的事件的字符串。请参见下面的列表。
callback
必需
函数事件触发时要调用的函数

eventName

可以是以下任意一个

  • keyboardWillShow(键盘将显示)
  • keyboardDidShow(键盘已显示)
  • keyboardWillHide(键盘将隐藏)
  • keyboardDidHide(键盘已隐藏)
  • keyboardWillChangeFrame(键盘帧将更改)
  • keyboardDidChangeFrame(键盘帧已更改)
注意

在 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;

如果软键盘可见,则返回其指标。