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

Keyboard

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

使用方法

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


リファレンス

メソッド

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:windowSoftInputModeadjustNothingに設定されている場合、Android 10以下ではイベントは発生しません。


dismiss()

tsx
static dismiss();

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


scheduleLayoutAnimation

tsx
static scheduleLayoutAnimation(event: KeyboardEvent);

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


isVisible()

tsx
static isVisible(): boolean;

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


metrics()

tsx
static metrics(): KeyboardMetrics | undefined;

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