关于KeyboardKit
KeyboardKit是一个SwiftUI SDK,只需几行代码即可让您创建完全可定制的[键盘扩展][About]。
KeyboardKit扩展了Apple有限的键盘API,增强了输入控制器和代理的功能,并为您提供额外的功能、状态和视图,让您能够构建出色的自定义键盘。
KeyboardKit是开源的,完全免费。它可以通过[KeyboardKit Pro][Pro]进行扩展,解锁Pro功能,如68种语言环境、自动完成和自动纠错、表情符号键盘、AI支持、主题、听写等更多功能。
安装
KeyboardKit可以通过Swift包管理器安装:
https://github.com/KeyboardKit/KeyboardKit.git
安装KeyboardKit后,请确保将其链接到所有需要它的目标。
入门
安装KeyboardKit后,只需让您的KeyboardViewController
继承KeyboardInputViewController
而不是UIInputViewController
:
import KeyboardKit
class KeyboardController: KeyboardInputViewController {}
这将使您的控制器可以访问新的生命周期函数,如viewWillSetupKeyboard
,可观察的状态,如state.keyboardContext
,以及服务,如services.actionHandler
等。
如果您只想使用标准的KeyboardView
,它模仿原生iOS键盘,您不需要做任何其他操作。KeyboardKit会为您设置好一切。
要替换或自定义标准的KeyboardView
,只需重写viewWillSetupKeyboard
并使用view
构建器调用setup
:
class KeyboardViewController: KeyboardInputViewController {
override func viewWillSetupKeyboard() {
super.viewWillSetupKeyboard()
setup { [weak self] controller in // <-- 如果您在这里需要self,请使用[weak self]或[unowned self]。
KeyboardView(
state: controller.state,
services: controller.services,
buttonContent: { $0.view },
buttonView: { $0.view },
emojiKeyboard: { $0.view },
toolbar: { _ in MyCustomToolbar() }
)
}
}
}
有关更多信息,请参阅[入门指南][Getting-Started]。
支持的语言环境
KeyboardKit支持[68种键盘特定的语言环境][Localization]:
🇦🇱 🇦🇪 🇦🇲 🇧🇾 🇧🇬 🇦🇩 🏳️ 🇭🇷 🇨🇿 🇩🇰
🇳🇱 🇧🇪 🇺🇸 🇬🇧 🇺🇸 🇪🇪 🇫🇴 🇵🇭 🇫🇮 🇫🇷
🇨🇦 🇧🇪 🇨🇭 🇬🇪 🇩🇪 🇦🇹 🇨🇭 🇬🇷 🇺🇸 🇮🇱
🇭🇺 🇮🇸 🏳️ 🇮🇩 🇮🇪 🇮🇹 🇰🇿 🇹🇯 🇹🇯 🇹🇯
🇱🇻 🇱🇹 🇲🇰 🇲🇾 🇲🇹 🇲🇳 🏳️ 🇳🇴 🇳🇴 🇮🇷
🇵🇱 🇵🇹 🇧🇷 🇷🇴 🇷🇺 🇷🇸 🇷🇸 🇸🇰 🇸🇮 🇪🇸
🇦🇷 🇲🇽 🇰🇪 🇸🇪 🇹🇷 🇺🇦 🇺🇿 🏴
KeyboardKit提供基本的键盘布局和基本的弹出操作。[KeyboardKit Pro][Pro]为所有支持的区域提供本地化的布局、弹出窗口和行为。
开源功能
KeyboardKit包含丰富的功能,帮助您构建出色的键盘扩展:
- ⌨️ [基础][Essentials] - KeyboardKit提供基本的实用工具、类型和视图。
- 💥 [操作][Actions] - KeyboardKit使触发键盘相关操作变得简单。
- 💡 [自动完成][Autocomplete] - KeyboardKit具有执行自动完成的方法。
- 🗯 [弹出窗口][Callouts] - KeyboardKit可以显示输入和二级操作弹出窗口。
- 🌈 [颜色][Colors] - KeyboardKit定义了键盘特定的颜色。
- 🖥️ [设备][Device] - KeyboardKit具有特定设备的实用工具。
- 😀 [表情符号][Emojis] - KeyboardKit定义了表情符号、类别、版本、肤色等。
- 🔉 [反馈][Feedback] - KeyboardKit可以触发音频和触觉反馈。
- 👆 [手势][Gestures] - KeyboardKit拥有可自定义的键盘手势引擎。
- 🏠 [主机][Host] - KeyboardKit可以识别主机应用程序。
- 🖼️ [图片][Images] - KeyboardKit定义了键盘特定的图片。
- 🔣 [布局][Layout] - KeyboardKit具有可自定义的输入集和键盘布局。
- 🌐 [本地化][Localization] - KeyboardKit支持68种区域设置。
- 🗺️ [导航][Navigation] - KeyboardKit允许您从键盘打开URL和应用程序。
- 👁 [预览][Previews] - KeyboardKit具有广泛的键盘预览支持。
- ➡️ [代理][Proxy] - KeyboardKit扩展了文本文档代理,增加了更多功能。
- ⚙️ [设置][Settings] - KeyboardKit提供了应用内设置和系统设置的工具。
- 🩺 [状态][Status] - KeyboardKit可以检测键盘是否启用、是否具有完全访问权限等。
- 🎨 [样式][Styling] - KeyboardKit允许您大幅度自定义键盘样式。
Pro功能
您可以升级到[KeyboardKit Pro][Pro]以解锁Pro功能。
- ⌨️ [基本功能][基本功能] - KeyboardKit Pro 解锁更多基本工具、键盘预览等。
- 🤖 [人工智能][人工智能] - KeyboardKit Pro 解锁人工智能所需的功能。
- 📱 [应用程序][应用程序] - KeyboardKit Pro 解锁特定应用的界面和视图。
- 💡 [自动完成][自动完成] - KeyboardKit Pro 解锁设备内和远程自动完成功能。
- 🗯 [提示框][提示框] - KeyboardKit Pro 为全部 68 种语言环境解锁本地化提示框。
- 🎤 [语音输入][语音输入] - KeyboardKit Pro 可以在键盘中执行语音输入。
- 😀 [表情符号][表情符号] - KeyboardKit Pro 解锁功能强大的表情符号键盘。
- ⌨️ [外部键盘][外部键盘] - KeyboardKit Pro 可以检测是否连接了外部键盘。
- 🔉 [反馈][反馈] - KeyboardKit Pro 解锁开启和关闭反馈的工具。
- 🏠 [宿主应用][宿主应用] - KeyboardKit Pro 可以识别特定的宿主应用程序。
- 🔣 [布局][布局] - KeyboardKit Pro 为全部 68 种语言环境解锁本地化布局。
- 🌐 [本地化][本地化] - KeyboardKit Pro 解锁 68 种特定语言环境的服务和键盘视图。
- 👁 [预览][预览] - KeyboardKit Pro 解锁键盘和主题预览功能。
- ➡️ [代理][代理] - KeyboardKit Pro 解锁让
UITextDocumentProxy
读取完整文档的方法。 - 📝 [文本][文本输入] - KeyboardKit Pro 解锁允许你在键盘内输入的工具。
- 🍭 [主题][主题] - KeyboardKit Pro 解锁主题引擎,包含多个预定义主题。
文档
[在线文档][文档]提供了更多信息、文章、代码示例等。
演示应用
演示应用展示了如何自定义键盘、显示键盘状态、链接到系统设置、应用自定义样式和主题等。
演示应用包含两个演示键盘:
Keyboard
使用 KeyboardKit 和自定义的KeyboardView
。KeyboardPro
使用 KeyboardKit Pro,启用所有语言环境、自动完成、主题等。
只需打开并运行 Demo
文件夹中的演示应用,然后在系统设置中启用键盘。请注意,某些功能(如触觉反馈)需要启用完全访问权限才能正常工作。
KeyboardKit 应用
如果你想在不编写代码或从 Xcode 构建演示应用的情况下试用 KeyboardKit Pro,App Store 中有一个 [KeyboardKit 应用][应用],可以让你试用许多专业版功能。
支持本项目
KeyboardKit 是开源的,完全免费,但你可以通过成为 [GitHub 赞助商][赞助商]、升级到 [KeyboardKit Pro][专业版] 或[联系我们][电子邮件]获取自由职业工作、付费支持等方式来支持项目。
联系方式
如果你有任何问题或想以任何方式贡献,请随时联系我们:
- 网站:[keyboardkit.com][网站]
- Mastodon:[@keyboardkit@techhub.social][Mastodon]
- Twitter:[@getkeyboardkit][Twitter]
- 电子邮件:[info@keyboardkit.com][电子邮件]
许可证
KeyboardKit 基于 MIT 许可证提供。有关更多信息,请参阅 [LICENSE][许可证] 文件。 [操作]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/actions-article [人工智能]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/ai-article [应用程序]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/app-article [自动完成]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/autocomplete-article [按钮]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/buttons-article [标注]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/callouts-article [颜色]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/colors-article [设备]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/device-article [听写]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/dictation-article [表情符号]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/emojis-article [外部]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/external-keyboards-article [反馈]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/feedback-article [手势]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/gestures-article [主机]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/host-article [图像]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/images-article [布局]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/layout-article [本地化]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/localization-article [导航]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/navigation-article [预览]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/previews-article [代理]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/proxy-article [设置]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/settings-article [状态]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/status-article [样式]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/styling-article [文本输入]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/text-input-article [主题]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/themes-article