跳到主要内容
版本：v8

@capacitor/keyboard

Keyboard API 提供了键盘显示和可见性控制功能，并能在键盘显示和隐藏时进行事件追踪。

安装​

npm install @capacitor/keyboard
npx cap sync

示例​

import { Keyboard } from '@capacitor/keyboard';

Keyboard.addListener('keyboardWillShow', info => {
  console.log('键盘即将显示，高度为：', info.keyboardHeight);
});

Keyboard.addListener('keyboardDidShow', info => {
  console.log('键盘已显示，高度为：', info.keyboardHeight);
});

Keyboard.addListener('keyboardWillHide', () => {
  console.log('键盘即将隐藏');
});

Keyboard.addListener('keyboardDidHide', () => {
  console.log('键盘已隐藏');
});

配置​

键盘可以通过以下选项进行配置：

属性类型描述默认值自版本
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>

显示键盘。

此方法仅支持 Android 平台。

自版本： 1.0.0

hide()​

hide() => Promise<void>

隐藏键盘。

自版本： 1.0.0

setAccessoryBarVisible(...)​

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

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

此方法仅支持 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>

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

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

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

返回值： 

Promise<PluginListenerHandle>

自： 1.0.0

addListener('keyboardDidShow', ...)​

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

监听键盘已显示的事件。

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

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

返回值： 

Promise<PluginListenerHandle>

自： 1.0.0

addListener('keyboardWillHide', ...)​

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

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

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

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

返回值： 

Promise<PluginListenerHandle>

自： 1.0.0

addListener('keyboardDidHide', ...)​

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

监听键盘已隐藏的事件。

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

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

返回值： 

Promise<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'键盘样式基于设备外观。如果设备使用深色模式，键盘将为深色；如果设备使用浅色模式，键盘将为浅色。1.0.0

KeyboardResize​

成员值说明自
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

编辑此页