实现自定义键盘功能
项目简介
本示例介绍自定义键盘的实现,通过绑定系统键盘,实现自定义键盘和系统键盘的切换;通过onAreaChange获取自定义键盘高度,设置布局避让;为开发者讲解键盘切换、自定义键盘光标处理、自定义键盘布局避让等技术场景案例。
效果预览
| 直板机 | 双折叠 | 平板 |
|---|---|---|
![]() |
![]() |
![]() |
使用说明
-
首页为消息列表,点击任意会话进入聊天详情页,点击页面底部输入框,默认拉起系统键盘;通过键盘菜单切换到自定义键盘后,布局会根据自定义键盘高度向上避让。
-
点击输入框左侧的键盘图标,在弹出的菜单中选择“系统键盘”、“自定义数字键盘”、“自定义英文键盘”进行切换;同时数字键盘上的“ABC”、英文键盘上的“123”按钮,也可在两种自定义键盘之间快速切换,实现一个输入框同时绑定自定义键盘和系统键盘。
-
支持键盘通用操作,包括内容输入、光标设置、大小写切换、剪切、粘贴、删除等功能。
工程目录
├──entry/src/main/ets // 代码区
│ ├──constants
│ │ └──Constants.ets // 公共常量类
│ ├──entryability
│ │ └──EntryAbility.ets // 程序入口类
│ ├──entrybackupability
│ │ └──EntryBackupAbility.ets // 数据备份
│ ├──model
│ │ ├──KeyboardController.ets // 自定义键盘控制类
│ │ └──WindowInfo.ets // 窗口信息类
│ ├──pages
│ │ └──MainPage.ets // 主页面
│ ├──utils
│ │ ├──Logger.ets // 日志工具
│ │ ├──WidthBreakpointType.ets // 宽度断点类型
│ │ └──WindowUtil.ets // 窗口工具
│ ├──view
│ │ ├──ChatViews.ets // 聊天视图
│ │ ├──CustomKeyboard.ets // 自定义键盘入口
│ │ ├──EnglishKeyboard.ets // 英文键盘组件
│ │ ├──KeyboardMenuPanel.ets // 键盘菜单面板
│ │ ├──NumberKeyboard.ets // 数字键盘组件
│ │ └──TextInputComponent.ets // 绑定自定义键盘的输入组件
│ └──viewmodel
│ ├──BreakpointConfig.ets // 断点配置
│ ├──ChatModel.ets // 聊天数据模型
│ ├──KeyboardHeightConfig.ets // 键盘高度配置
│ └──MenuModel.ets // 键盘按钮数据
└──entry/src/main/resources // 应用资源目录
具体实现
- TextInput组件customKeyboard属性绑定builder,实现自定义键盘。
- TextInput组件customKeyboard属性传值null,绑定系统键盘,实现自定义键盘和系统键盘的切换。
- 监听TextInput组件onTextSelectionChange、onChange事件,实现光标位置设置。
- 监听TextInput组件onCut、onPaste事件,实现剪切、粘贴功能。
- 通过WindowUtil封装window的keyboardHeightChange、windowSizeChange事件,获取系统键盘高度与窗口尺寸变化;通过CustomKeyboard的onAreaChange事件获取自定义键盘高度,设置布局避让。
相关权限
不涉及。
依赖
不涉及。
约束与限制
-
本示例仅支持标准系统上运行,支持设备:直板机、双折叠、三折叠、阔折叠、平板、电脑。
-
HarmonyOS系统:HarmonyOS 26.0.0 Release及以上。
-
DevEco Studio版本:DevEco Studio 26.0.0 Release及以上。
-
HarmonyOS SDK版本:HarmonyOS SDK 26.0.0 Release及以上。


