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

Keyboard

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

使用法

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


リファレンス

メソッド

addListener()

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

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

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

パラメータ

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

eventName

これは、次のいずれかになります。

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

AndroidではkeyboardDidShowおよびkeyboardDidHideイベントのみが利用可能であることに注意してください。アクティビティのandroid:windowSoftInputModeadjustNothingに設定されている場合、Android 10以下を使用しているときはイベントは発生しません。


dismiss()

static dismiss();

アクティブなキーボードを閉じ、フォーカスを削除します。


scheduleLayoutAnimation

static scheduleLayoutAnimation(event: KeyboardEvent);

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


isVisible()

static isVisible(): boolean;

キーボードが最後に表示された状態かどうか。


metrics()

static metrics(): KeyboardMetrics | undefined;

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