KeyboardPlugin

hide

hide(): Promise<void>
Hide the keyboard.
Returns: Promise<void>

setAccessoryBarVisible

setAccessoryBarVisible(options: { isVisible: boolean }): Promise<void>
Set whether the accessory bar should be visible on the keyboard. We recommend disabling the accessory bar for short forms (login, signup, etc.) to provide a cleaner UI
options { isVisible: boolean }
Returns: Promise<void>

setResizeMode

setResizeMode(options: KeyboardResizeOptions): Promise<void>
Programmatically set the resize mode
options KeyboardResizeOptions
Returns: Promise<void>

setScroll

setScroll(options: { isDisabled: boolean }): Promise<void>
Programmatically enable or disable the WebView scroll
options { isDisabled: boolean }
Returns: Promise<void>

setStyle

setStyle(options: KeyboardStyleOptions): Promise<void>
Programmatically set the keyboard style
options KeyboardStyleOptions
Returns: Promise<void>

show

show(): Promise<void>
Show the keyboard. This method is alpha and may have issues
Returns: Promise<void>

addListener

addListener(eventName: "keyboardWillShow", listenerFunc: (info: KeyboardInfo) => void): PluginListenerHandle
eventName "keyboardWillShow"
listenerFunc (info: KeyboardInfo) => void
Returns: PluginListenerHandle

addListener

addListener(eventName: "keyboardDidShow", listenerFunc: (info: KeyboardInfo) => void): PluginListenerHandle
eventName "keyboardDidShow"
listenerFunc (info: KeyboardInfo) => void
Returns: PluginListenerHandle

addListener

addListener(eventName: "keyboardWillHide", listenerFunc: () => void): PluginListenerHandle
eventName "keyboardWillHide"
listenerFunc () => void
Returns: PluginListenerHandle

addListener

addListener(eventName: "keyboardDidHide", listenerFunc: () => void): PluginListenerHandle
eventName "keyboardDidHide"
listenerFunc () => void
Returns: PluginListenerHandle

Interfaces Used

KeyboardResizeOptions

interface KeyboardResizeOptions {
mode : KeyboardResize;
}

KeyboardStyleOptions

interface KeyboardStyleOptions {
style : KeyboardStyle;
}

KeyboardResize

enum KeyboardResize {
Body: "body"
Ionic: "ionic"
Native: "native"
None: "none"
}

KeyboardStyle

enum KeyboardStyle {
Dark: "DARK"
Light: "LIGHT"
}