The Keyboard API provides keyboard display and visibility control, along with event tracking when the keyboard shows and hides.
npm install @capacitor/keyboardThe Keyboard API provides keyboard display and visibility control, along with event tracking when the keyboard shows and hides.
``bash`
npm install @capacitor/keyboard
npx cap sync
`typescript
import { Keyboard } from '@capacitor/keyboard';
Keyboard.addListener('keyboardWillShow', info => {
console.log('keyboard will show with height:', info.keyboardHeight);
});
Keyboard.addListener('keyboardDidShow', info => {
console.log('keyboard did show with height:', info.keyboardHeight);
});
Keyboard.addListener('keyboardWillHide', () => {
console.log('keyboard will hide');
});
Keyboard.addListener('keyboardDidHide', () => {
console.log('keyboard did hide');
});
`
On iOS, the keyboard can be configured with the following options:
| Prop | Type | Description | Default | Since |
| ------------------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ----- |
| resize | KeyboardResize | Configure the way the app is resized when the Keyboard appears. Only available on iOS. | native | 1.0.0 |
| style | KeyboardStyle | Override the keyboard style if your app doesn't support dark/light theme changes. If not set, the keyboard style will depend on the device appearance. Only available on iOS. | | 1.0.0 |
| resizeOnFullScreen | boolean | There is an Android bug that prevents the keyboard from resizing the WebView when the app is in full screen (i.e. if StatusBar plugin is used to overlay the status bar). This setting, if set to true, add a workaround that resizes the WebView even when the app is in full screen. Only available for Android | | 1.1.0 |
In capacitor.config.json:
`json`
{
"plugins": {
"Keyboard": {
"resize": "body",
"style": "DARK",
"resizeOnFullScreen": true
}
}
}
In capacitor.config.ts:
`ts
///
import { CapacitorConfig } from '@capacitor/cli';
import { KeyboardResize, KeyboardStyle } from '@capacitor/keyboard';
const config: CapacitorConfig = {
plugins: {
Keyboard: {
resize: KeyboardResize.Body,
style: KeyboardStyle.Dark,
resizeOnFullScreen: true,
},
},
};
export default config;
`
To maintain compatibility with
cordova-plugin-ionic-keyboard,
the following events also work with window.addEventListener:
- keyboardWillShow
-
-
-
* show()
* hide()
* setAccessoryBarVisible(...)
* setScroll(...)
* setStyle(...)
* setResizeMode(...)
* getResizeMode()
* addListener('keyboardWillShow', ...)
* addListener('keyboardDidShow', ...)
* addListener('keyboardWillHide', ...)
* addListener('keyboardDidHide', ...)
* removeAllListeners()
* Interfaces
* Enums
`typescript`
show() => Promise
Show the keyboard.
This method is only supported on Android.
Since: 1.0.0
--------------------
`typescript`
hide() => Promise
Hide the keyboard.
Since: 1.0.0
--------------------
`typescript`
setAccessoryBarVisible(options: { isVisible: boolean; }) => Promise
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.
This method is only supported on iPhone devices.
| Param | Type |
| ------------- | ------------------------------------ |
| options | { isVisible: boolean; } |
Since: 1.0.0
--------------------
`typescript`
setScroll(options: { isDisabled: boolean; }) => Promise
Programmatically enable or disable the WebView scroll.
This method is only supported on iOS.
| Param | Type |
| ------------- | ------------------------------------- |
| options | { isDisabled: boolean; } |
Since: 1.0.0
--------------------
`typescript`
setStyle(options: KeyboardStyleOptions) => Promise
Programmatically set the keyboard style.
This method is only supported on iOS.
| Param | Type |
| ------------- | --------------------------------------------------------------------- |
| options | KeyboardStyleOptions |
Since: 1.0.0
--------------------
`typescript`
setResizeMode(options: KeyboardResizeOptions) => Promise
Programmatically set the resize mode.
This method is only supported on iOS.
| Param | Type |
| ------------- | ----------------------------------------------------------------------- |
| options | KeyboardResizeOptions |
Since: 1.0.0
--------------------
`typescript`
getResizeMode() => Promise
Get the currently set resize mode.
This method is only supported on iOS.
Returns: Promise<KeyboardResizeOptions>
Since: 4.0.0
--------------------
`typescript`
addListener(eventName: 'keyboardWillShow', listenerFunc: (info: KeyboardInfo) => void) => Promise
Listen for when the keyboard is about to be shown.
On Android keyboardWillShow and keyboardDidShow fire almost at the same time.
| Param | Type |
| ------------------ | ------------------------------------------------------------------------ |
| eventName | 'keyboardWillShow' |
| listenerFunc | (info: KeyboardInfo) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
--------------------
`typescript`
addListener(eventName: 'keyboardDidShow', listenerFunc: (info: KeyboardInfo) => void) => Promise
Listen for when the keyboard is shown.
On Android keyboardWillShow and keyboardDidShow fire almost at the same time.
| Param | Type |
| ------------------ | ------------------------------------------------------------------------ |
| eventName | 'keyboardDidShow' |
| listenerFunc | (info: KeyboardInfo) => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
--------------------
`typescript`
addListener(eventName: 'keyboardWillHide', listenerFunc: () => void) => Promise
Listen for when the keyboard is about to be hidden.
On Android keyboardWillHide and keyboardDidHide fire almost at the same time.
| Param | Type |
| ------------------ | ------------------------------- |
| eventName | 'keyboardWillHide' |
| listenerFunc | () => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
--------------------
`typescript`
addListener(eventName: 'keyboardDidHide', listenerFunc: () => void) => Promise
Listen for when the keyboard is hidden.
On Android keyboardWillHide and keyboardDidHide fire almost at the same time.
| Param | Type |
| ------------------ | ------------------------------ |
| eventName | 'keyboardDidHide' |
| listenerFunc | () => void |
Returns: Promise<PluginListenerHandle>
Since: 1.0.0
--------------------
`typescript`
removeAllListeners() => Promise
Remove all native listeners for this plugin.
Since: 1.0.0
--------------------
#### KeyboardStyleOptions
| Prop | Type | Description | Default | Since |
| ----------- | ------------------------------------------------------- | ---------------------- | ---------------------------------- | ----- |
| style | KeyboardStyle | Style of the keyboard. | KeyboardStyle.Default | 1.0.0 |
#### KeyboardResizeOptions
| Prop | Type | Description | Since |
| ---------- | --------------------------------------------------------- | ------------------------------------------------------- | ----- |
| mode | KeyboardResize | Mode used to resize elements when the keyboard appears. | 1.0.0 |
#### PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| remove | () => Promise<void> |
#### KeyboardInfo
| Prop | Type | Description | Since |
| -------------------- | ------------------- | ----------------------- | ----- |
| keyboardHeight | number | Height of the keyboard. | 1.0.0 |
#### KeyboardStyle
| Members | Value | Description | Since |
| ------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| Dark | 'DARK' | Dark keyboard. | 1.0.0 |
| Light | 'LIGHT' | Light keyboard. | 1.0.0 |
| Default | 'DEFAULT' | The keyboard style is based on the device appearance. If the device is using Dark mode, the keyboard will be dark. If the device is using Light mode, the keyboard will be light. | 1.0.0 |
#### KeyboardResize
| Members | Value | Description | Since |
| ------------ | --------------------- | -------------------------------------------------------------------------------------------------------------------- | ----- |
| Body | 'body' | Only the body HTML element will be resized. Relative units are not affected, because the viewport does not change. | 1.0.0 |Ionic
| | ion-app'ionic' | Only the HTML element will be resized. Use it only for Ionic Framework apps. | 1.0.0 |Native
| | vh'native' | The whole native Web View will be resized when the keyboard shows/hides. This affects the relative unit. | 1.0.0 |None` |
| 'none' | Neither the app nor the Web View are resized. | 1.0.0 |