Keyboard module to control keyboard events.

Usage​

The Keyboard module allows you to listen for native events and react to them, as well as make changes to the keyboard, like dismissing it.

Reference

Methods​

addListener()​

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

The addListener function connects a JavaScript function to an identified native keyboard notification event.

This function then returns the reference to the listener.

Parameters:

eventName

This can be any of the following:

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

Note that only keyboardDidShow and keyboardDidHide events are available on Android. The events will not be fired when using Android 10 and under if your activity has android:windowSoftInputMode set to adjustNothing.

dismiss()​

staticdismiss();

Dismisses the active keyboard and removes focus.

scheduleLayoutAnimation​

staticscheduleLayoutAnimation(event:KeyboardEvent);

Useful for syncing TextInput (or other keyboard accessory view) size of position changes with keyboard movements.

isVisible()​

staticisVisible():boolean;

Whether the keyboard is last known to be visible.

metrics()​

staticmetrics():KeyboardMetrics|undefined;

Return the metrics of the soft-keyboard if visible.