メインコンテンツへスキップ

Keyboard

キーボードイベントを制御するためのKeyboardモジュール。

使い方

Keyboardモジュールを使用すると、ネイティブイベントをリッスンしてそれらに反応したり、キーボードを閉じるなどの変更を加えたりすることができます。


リファレンス

Methods

addListener()

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

addListener関数は、JavaScript関数を識別されたネイティブキーボード通知イベントに接続します。

この関数は、リスナーへの参照を返します。

パラメータ

名前説明
eventName
必須
stringリッスンしているイベントを識別する文字列。以下のリストを参照してください。
callback
必須
functionイベント発生時に呼び出される関数

eventName

これは以下のいずれかです

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

AndroidではkeyboardDidShowkeyboardDidHideイベントのみが利用可能です。アクティビティのandroid:windowSoftInputModeadjustResizeまたはadjustNothingに設定されている場合、Android 10以前ではイベントは発生しません。


dismiss()

tsx
static dismiss();

アクティブなキーボードを非表示にし、フォーカスを解除します。


scheduleLayoutAnimation

tsx
static scheduleLayoutAnimation(event: KeyboardEvent);

TextInput(または他のキーボードアクセサリビュー)のサイズや位置の変更をキーボードの動きと同期させるのに便利です。


isVisible()

tsx
static isVisible(): boolean;

キーボードが最後に認識された時点で表示されているかどうか。


metrics()

tsx
static metrics(): KeyboardMetrics | undefined;

ソフトキーボードが表示されている場合、そのメトリクスを返します。