ArtfulCoder/KeyboardKit

代码拉取完成,页面将自动刷新

richgiteeai

Watch

不关注关注所有动态仅关注版本发行动态关注但不提醒动态

1 Star 0 Fork 0

ArtfulCoder/KeyboardKit

代码 Issues 0 Pull Requests 0 Wiki 统计流水线

服务

加入 Gitee

与超过 1400万开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)

免费加入

已有帐号? 立即登录

克隆/下载

HTTPS SSH SVN SVN+SSH 下载ZIP

提示

下载代码请复制以下命令到终端执行

为确保你提交的代码身份被 Gitee 正确识别,请执行以下命令完成配置

git config --global user.name userName 
git config --global user.email userEmail

初次使用 SSH 协议进行代码克隆、推送等操作时,需按下述提示完成 SSH 配置

1 生成 RSA 密钥

2 获取 RSA 公钥内容,并配置到 SSH公钥中

在 Gitee 上使用 SVN,请访问使用指南

使用 HTTPS 协议时,命令行会出现如下账号密码验证步骤。基于安全考虑,Gitee 建议配置并使用私人令牌替代登录密码进行克隆、推送等操作

Username for 'https://gitee.com': userName

Password for 'https://userName@gitee.com': # 私人令牌

新建文件新建 Diagram 文件

新建子模块

上传文件

分支 3

标签 269

贡献代码

同步代码

创建 Pull Request

了解更多

对比差异通过 Pull Request 同步

同步更新到分支

通过 Pull Request 同步

将会在向当前分支创建一个 Pull
Request,合入后将完成同步

Daniel Saidi Update package 9b38e0a

3764 次提交

.github/workflows

.swiftpm/xcode/package.xcworkspace

Demo

Dependencies/KeyboardKitDependencies

Docs

Resources

.gitignore

LICENSE

Package.resolved

Package.swift

README.md

RELEASE_NOTES.md

README

未知许可证

# KeyboardKit

KeyboardKit lets you create amazing [custom keyboard extensions][About] with a few lines of code, using Swift & SwiftUI.

KeyboardKit extends Apple's limited keyboard APIs with more capabilities. It can be extended with [KeyboardKit Pro][Pro], which unlocks localized keyboards, autocomplete, an emoji keyboard, AI support, themes, and much more.

## Installation

KeyboardKit can be installed with the Swift Package Manager:

```
https://github.com/KeyboardKit/KeyboardKit.git
```

Since KeyboardKit is a binary framework, it must only linked to the main app target. All other targets will be able to use it without linking.

## Getting Started

The easiest way to set up KeyboardKit is to first create a `KeyboardApp` value for your app:

```swift
import KeyboardKit

extension KeyboardApp {

static var keyboardKitDemo: KeyboardApp {
 .init(
 name: "KeyboardKit",
 licenseKey: "your-key-here", // Needed for KeyboardKit Pro!
 appGroupId: "group.com.keyboardkit.demo", // Sets up App Group data sync
 locales: .keyboardKitSupported, // Sets up the enabled locales
 autocomplete: .init( // Sets up custom autocomplete 
 nextWordPredictionRequest: .claude(...) // Sets up AI-based prediction
 ),
 deepLinks: .init(app: "kkdemo://", ...) // Defines how to open the app
 )
 }
}
```

Next, let your `KeyboardController` inherit ``KeyboardInputViewController`` instead of `UIInputViewController`:

```swift
class KeyboardController: KeyboardInputViewController {}
```

This unlocks additional functions and capabilities, and adds `services` and observable `state` to the controller.

Next, override `viewDidLoad()` and call `setup(for:)` to set up the keyboard extension for your app:

```swift
class KeyboardViewController: KeyboardInputViewController {

override func viewDidLoad() {
 super.viewDidLoad()
 
 // Set up the keyboard with the app we created above
 setup(for: .keyboardKitDemo) { result in
 // If `result` is `.success`, the setup did succeed.
 // This is where you can setup custom services, etc.
 }
 }
}
```

This will make keyboard settings sync data between the main app and its keyboard if the `KeyboardApp` defines an ``appGroupId``, set up KeyboardKit Pro if it defines a ``licenseKey``, set up dictation and deep links, etc.

To replace or customize the standard ``KeyboardView``, just override `viewWillSetupKeyboardView()` and let it call `setupKeyboardView(_:)` with the view that you want to use:

```swift
class KeyboardViewController: KeyboardInputViewController {

override func viewWillSetupKeyboardView() {
 setupKeyboardView { [weak self] controller in // <-- Use weak or unknowned self!
 KeyboardView(
 state: controller.state,
 buttonContent: { 0ドル.view },
 buttonView: { 0ドル.view },
 collapsedView: { 0ドル.view },
 emojiKeyboard: { 0ドル.view },
 toolbar: { 0ドル.view }
 )
 }
 }
}
```

To set up your main app with the same keyboard configuration, just wrap the content view in a `KeyboardAppView`:

```swift
@main
struct MyApp: App {

var body: some Scene {
 WindowGroup {
 
 // Here we use the keyboard app we created above
 KeyboardAppView(for: .keyboardKitDemo) {
 ContentView()
 }
 }
 }
}
```

For more information, see the [getting started guide][Getting-Started] and [essentials][Essentials] articles.

## Localization

KeyboardKit supports [75 locales][Localization]:

🇺🇸 🇦🇱 🇦🇪 🇦🇲 🇦🇿 🇧🇾 🇧🇩 🇧🇬 🇦🇩 🏳️ 
🏳️ 🇭🇷 🇨🇿 🇩🇰 🇳🇱 🇧🇪 🇦🇺 🇨🇦 🇬🇧 🇺🇸 
🇪🇪 🇫🇴 🇵🇭 🇫🇮 🇫🇷 🇨🇦 🇧🇪 🇨🇭 🇬🇪 🇩🇪 
🇦🇹 🇨🇭 🇬🇷 🇺🇸 🇮🇱 🇭🇺 🇮🇸 🏳️ 🇮🇩 🇮🇪 
🇮🇹 🇰🇿 🇹🇯 🇹🇯 🇹🇯 🇱🇻 🇱🇹 🇲🇰 🇲🇾 🇲🇹 
🇲🇳 🏳️ 🇳🇴 🇳🇴 🇮🇷 🇵🇱 🇵🇹 🇧🇷 🇷🇴 🇷🇺 
🇷🇸 🇷🇸 🇹🇯 🇸🇰 🇸🇮 🇪🇸 🇦🇷 🇲🇽 🇸🇪 🇰🇪 
🇹🇷 🇺🇦 🇺🇿 🇻🇳 🏴󠁧󠁢󠁷󠁬󠁳󠁿

[KeyboardKit Pro][Pro] unlocks localized keyboards, layouts, callouts and behaviors for all supported locales.

## Features

KeyboardKit provides a free, open-source keyboard engine. [KeyboardKit Pro][Pro] unlocks more powerful pro features.

* 🌱 [Essentials][Essentials] - Essential utilities, models, services & views.
* ⌨️ [Essentials - KeyboardView][Essentials-KeyboardView] - Render a native-looking, fully customizable keyboard.
* 💥 [Actions][Actions] - Trigger & handle keyboard-related actions.
* 🤖 [AI][AI] - Features that are needed by AI-based keyboards.
* 📱 [App][App] - App-specific utilities, settings, screens, etc.
* 💡 [Autocomplete][Autocomplete] - Autocomplete and autocorrect as the user types.
* 🗯 [Callouts][Callouts] - Show input & secondary action callouts.
* 📋 [Clipboard][Clipboard] - Create custom clips and integrate with the system clipboard.
* 🎤 [Dictation][Dictation] - Trigger dictation from the keyboard.
* 😀 [Emojis][Emojis] - Emoji models, an emoji keyboard, etc.
* ⌨️ [External][External] - Detect if an external keyboard is connected.
* 🔉 [Feedback][Feedback] - Trigger audio & haptic feedback with ease.
* A [Fonts][Fonts] - Type with other fonts than the standard system font.
* 👆 [Gestures][Gestures] - Handle a rich set of gestures on any key.
* 🏠 [Host][Host] - Identify and open the host application.
* 📝 [Input][Input] - Keyboard input fields, Vietnamese support, etc.
* 🔣 [Layout][Layout] - A dynamic, customizable keyboard layout engine.
* 🌐 [Localization][Localization] - Locale-specific utilities for all supported locales.
* 🗺️ [Navigation][Navigation] - Open urls and other apps from the keyboard.
* 👁 [Previews][Previews] - Keyboard & theme previews for in-app use.
* 📄 [Proxy][Proxy] - Extend the text document proxy with more capabilities.
* ⚙️ [Settings][Settings] - Provide keyboard settings & link to System Settings.
* 🩺 [Status][Status] - Detect if a keyboard is enabled, has full access, etc.
* 🎨 [Styling][Styling] - Style your keyboard to great extent.
* 🍭 [Themes][Themes] - A theme engine with many pre-defined themes.

## Documentation

The [online documentation][Documentation] has a [getting started guide][Getting-Started], [feature articles][Feature-Articles], code samples, [developer guides][Developer-Guides], etc.

## Demo App

The `Demo` folder has a demo app that shows how to set up a main app and its keyboard extension, show keyboard status, provide in-app settings, link to system settings, apply custom styles, etc.

> [!IMPORTANT]
> The demo isn't code signed and can therefore not use an App Group to sync settings between the app and its keyboards. As such, the `KeyboardPro` keyboard has keyboard settings in the keyboard as well.

## KeyboardKit App

The [KeyboardKit app][KeyboardKit-App] on the App Store lets you download and try KeyboardKit without having to write any code.

## Support This Project

KeyboardKit is free to use, but you can support us by becoming a [GitHub Sponsor][Sponsors], upgrading to [KeyboardKit Pro][Pro] or [get in touch][Email] for freelance work, paid support etc.

## Contact

Feel free to reach out if you have questions or if you want to contribute in any way:

* Website: [keyboardkit.com][Website]
* E-mail: [info@keyboardkit.com][Email]
* Bluesky: [@keyboardkit.bsky.social][Bluesky]
* Mastodon: [@keyboardkit@techhub.social][Mastodon]

## License

KeyboardKit is closed-source. See the [LICENSE][License] file for more info.

[Email]: mailto:info@keyboardkit.com
[Website]: https://keyboardkit.com
[Bluesky]: https://bsky.app/profile/keyboardkit.bsky.social
[Mastodon]: https://techhub.social/@keyboardkit
[Sponsors]: https://github.com/sponsors/danielsaidi

[About]: https://keyboardkit.com/about
[KeyboardKit-App]: https://keyboardkit.com/app

[Pro]: https://keyboardkit.com/pro
[Documentation]: https://docs.keyboardkit.com
[License]: https://github.com/KeyboardKit/KeyboardKit/blob/master/LICENSE

[Getting-Started]: https://docs.keyboardkit.com/documentation/keyboardkit/getting-started-article
[Essentials]: https://docs.keyboardkit.com/documentation/keyboardkit/essentials-article
[Essentials-KeyboardView]: https://docs.keyboardkit.com/documentation/keyboardkit/essentials-keyboardview
[Developer-Guides]: https://docs.keyboardkit.com/documentation/keyboardkit/developer-articles
[Feature-Articles]: https://docs.keyboardkit.com/documentation/keyboardkit/features-articles

[Actions]: https://docs.keyboardkit.com/documentation/keyboardkit/actions-article
[AI]: https://docs.keyboardkit.com/documentation/keyboardkit/ai-article
[App]: https://docs.keyboardkit.com/documentation/keyboardkit/app-article
[Autocomplete]: https://docs.keyboardkit.com/documentation/keyboardkit/autocomplete-article
[Buttons]: https://docs.keyboardkit.com/documentation/keyboardkit/buttons-article
[Callouts]: https://docs.keyboardkit.com/documentation/keyboardkit/callouts-article
[Clipboard]: https://docs.keyboardkit.com/documentation/keyboardkit/clipboard-article
[Dictation]: https://docs.keyboardkit.com/documentation/keyboardkit/dictation-article
[Emojis]: https://docs.keyboardkit.com/documentation/keyboardkit/emojis-article
[External]: https://docs.keyboardkit.com/documentation/keyboardkit/external-keyboards-article
[Feedback]: https://docs.keyboardkit.com/documentation/keyboardkit/feedback-article
[Fonts]: https://docs.keyboardkit.com/documentation/keyboardkit/fonts-article
[Gestures]: https://docs.keyboardkit.com/documentation/keyboardkit/gestures-article
[Host]: https://docs.keyboardkit.com/documentation/keyboardkit/host-article
[Input]: https://docs.keyboardkit.com/documentation/keyboardkit/input-article
[Layout]: https://docs.keyboardkit.com/documentation/keyboardkit/layout-article
[Localization]: https://docs.keyboardkit.com/documentation/keyboardkit/localization-article
[Navigation]: https://docs.keyboardkit.com/documentation/keyboardkit/navigation-article
[Previews]: https://docs.keyboardkit.com/documentation/keyboardkit/previews-article
[Proxy]: https://docs.keyboardkit.com/documentation/keyboardkit/proxy-article
[Settings]: https://docs.keyboardkit.com/documentation/keyboardkit/settings-article
[Status]: https://docs.keyboardkit.com/documentation/keyboardkit/status-article
[Styling]: https://docs.keyboardkit.com/documentation/keyboardkit/styling-article
[Themes]: https://docs.keyboardkit.com/documentation/keyboardkit/themes-article

Closed Source License Copyright (c) 2016-2026 Kankoda Sweden AB KeyboardKit (hereby referred to as "the Software") is closed-source. The Software is free to start using and has commercial pro features that require a valid license to be used. The Software's pro features must only be used in the application(s) that are included in the license agreement. The source code must not be distributed to or used by other individuals, teams or companies. If you see the source code being publicly exposed elsewhere, please reach out to info@kankoda.com. You will be compensated for your help. Any attempts to work around these limitations or to circumvent the security mechanisms of the Software, or any attempts to reverse engineer the software, will be considered as an attempt to violate the license agreement and may render the unauthorized user of the software liable to compensate the licensee for any damages, loss of IP or any other economic losses caused by the infringement. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT ANY WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED, TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.