跳到主要内容
版本：v5

@capacitor/keyboard

Keyboard API 提供键盘显示与可见性控制，以及键盘显示和隐藏时的事件追踪功能。

安装​

npm install @capacitor/keyboard@latest-5
npx cap sync

示例​

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');
});

配置​

在 iOS 上，键盘可以通过以下选项进行配置：

属性类型描述默认值自版本
resize
KeyboardResize
配置键盘出现时应用程序的调整方式。仅在 iOS 上可用。native1.0.0
style
KeyboardStyle
如果你的应用不支持深色/浅色主题切换，可以覆盖键盘样式。如果未设置，键盘样式将取决于设备外观。仅在 iOS 上可用。1.0.0
resizeOnFullScreenbooleanAndroid 存在一个 bug，当应用处于全屏模式时（例如使用 StatusBar 插件覆盖状态栏），键盘无法调整 WebView 大小。此设置若设为 true，会添加一个变通方案，即使应用处于全屏模式也能调整 WebView 大小。仅适用于 Android。1.1.0

配置示例​

在 capacitor.config.json 中：

{
  "plugins": {
    "Keyboard": {
      "resize": "body",
      "style": "DARK",
      "resizeOnFullScreen": true
    }
  }
}

在 capacitor.config.ts 中：

/// <reference types="@capacitor/keyboard" />

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;

与 cordova-plugin-ionic-keyboard 的兼容性​

为了保持与 cordova-plugin-ionic-keyboard 的兼容性，以下事件也可以通过 window.addEventListener 使用：

  • keyboardWillShow
  • keyboardDidShow
  • keyboardWillHide
  • keyboardDidHide

API​

show()​

show() => Promise<void>

显示键盘。此方法处于 alpha 阶段，可能存在问题。

此方法仅在 Android 上受支持。

自版本： 1.0.0

hide()​

hide() => Promise<void>

隐藏键盘。

自版本： 1.0.0

setAccessoryBarVisible(...)​

setAccessoryBarVisible(options: { isVisible: boolean; }) => Promise<void>

设置键盘上的辅助工具栏（accessory bar）是否可见。对于短表单（登录、注册等），我们建议禁用辅助工具栏以提供更简洁的用户界面。

此方法仅在 iPhone 设备上受支持。

参数类型
options{ isVisible: boolean; }

自版本： 1.0.0

setScroll(...)​

setScroll(options: { isDisabled: boolean; }) => Promise<void>

以编程方式启用或禁用 WebView 滚动。

此方法仅在 iOS 上受支持。

参数类型
options{ isDisabled: boolean; }

自版本： 1.0.0

setStyle(...)​

setStyle(options: KeyboardStyleOptions) => Promise<void>

以编程方式设置键盘样式。

此方法仅在 iOS 上受支持。

参数类型
options
KeyboardStyleOptions

自版本： 1.0.0

setResizeMode(...)​

setResizeMode(options: KeyboardResizeOptions) => Promise<void>

以编程方式设置调整大小模式。

此方法仅在 iOS 上受支持。

参数类型
options
KeyboardResizeOptions

自版本： 1.0.0

--------------------### getResizeMode()

getResizeMode() => Promise<KeyboardResizeOptions>

获取当前设置的键盘重设模式。

此方法仅在 iOS 上受支持。

返回: 

Promise<KeyboardResizeOptions>

自版本: 4.0.0

addListener('keyboardWillShow', ...)​

addListener(eventName: 'keyboardWillShow', listenerFunc: (info: KeyboardInfo) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听键盘即将显示的事件。

在 Android 上，keyboardWillShow 和 keyboardDidShow 几乎同时触发。

参数类型
eventName'keyboardWillShow'
listenerFunc
(info: KeyboardInfo) => void

返回: 

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

addListener('keyboardDidShow', ...)​

addListener(eventName: 'keyboardDidShow', listenerFunc: (info: KeyboardInfo) => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听键盘已显示的事件。

在 Android 上，keyboardWillShow 和 keyboardDidShow 几乎同时触发。

参数类型
eventName'keyboardDidShow'
listenerFunc
(info: KeyboardInfo) => void

返回: 

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

addListener('keyboardWillHide', ...)​

addListener(eventName: 'keyboardWillHide', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听键盘即将隐藏的事件。

在 Android 上，keyboardWillHide 和 keyboardDidHide 几乎同时触发。

参数类型
eventName'keyboardWillHide'
listenerFunc() => void

返回: 

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

addListener('keyboardDidHide', ...)​

addListener(eventName: 'keyboardDidHide', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

监听键盘已隐藏的事件。

在 Android 上，keyboardWillHide 和 keyboardDidHide 几乎同时触发。

参数类型
eventName'keyboardDidHide'
listenerFunc() => void

返回: 

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

removeAllListeners()​

removeAllListeners() => Promise<void>

移除此插件的所有原生监听器。

自版本: 1.0.0

接口​

KeyboardStyleOptions​

属性类型描述默认值自版本
style
KeyboardStyle
键盘样式。KeyboardStyle.Default1.0.0

KeyboardResizeOptions​

属性类型描述自版本
mode
KeyboardResize
键盘出现时用于调整元素大小的模式。1.0.0

PluginListenerHandle​

属性类型
remove() => Promise<void>

KeyboardInfo​

属性类型描述自版本
keyboardHeightnumber键盘高度。1.0.0

枚举​

KeyboardStyle​

成员值描述自版本
Dark'DARK'深色键盘。1.0.0
Light'LIGHT'浅色键盘。1.0.0
Default'DEFAULT'在 iOS 13 及更高版本上，键盘样式基于设备外观。如果设备使用深色模式，键盘将显示为深色。如果设备使用浅色模式，键盘将显示为浅色。在 iOS 12 上，键盘将始终为浅色。1.0.0
成员值说明始于版本
Body'body'仅调整 body HTML 元素的大小。由于视口未改变，相对单位不受影响。1.0.0
Ionic'ionic'仅调整 ion-app HTML 元素的大小。仅适用于 Ionic Framework 应用。1.0.0
Native'native'键盘显示/隐藏时，调整整个原生 Web View 的大小。这会影响 vh 相对单位。1.0.0
None'none'应用和 Web View 均不调整大小。1.0.0

Contents

编辑此页