https://github.com/keyboardkit/keyboardkitpro
KeyboardKit Pro lets you create custom keyboard extensions with a few lines of code, using Swift & SwiftUI.
https://github.com/keyboardkit/keyboardkitpro
apple emoji ios keyboard keyboard-extension macos swift swiftui tvos watchos
Last synced: 3 months ago
JSON representation
KeyboardKit Pro lets you create custom keyboard extensions with a few lines of code, using Swift & SwiftUI.
- Host: GitHub
- URL: https://github.com/keyboardkit/keyboardkitpro
- Owner: KeyboardKit
- License: other
- Created: 2021-02-16T08:49:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-01T13:01:44.000Z (3 months ago)
- Last Synced: 2025-04-05T22:05:05.529Z (3 months ago)
- Topics: apple, emoji, ios, keyboard, keyboard-extension, macos, swift, swiftui, tvos, watchos
- Language: Shell
- Homepage: https://keyboardkit.com
- Size: 184 MB
- Stars: 124
- Watchers: 6
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KeyboardKit Pro
[KeyboardKit][KeyboardKit] lets you create amazing [custom keyboard extensions][About] with a few lines of code, using Swift & SwiftUI.
KeyboardKit Pro extends KeyboardKit with Pro features, such as fully localized keyboards, autocomplete, an emoji keyboard, AI support, integrations, themes, and much more. See the [feature table](#pro-features) below.
KeyboardKit Pro requires a license to be used. You can sign up on the [KeyboardKit website][Website] or the [Gumroad store][Gumroad].
## Installation
KeyboardKit Pro can be installed with the Swift Package Manager:
```
https://github.com/KeyboardKit/KeyboardKitPro.git
```
KeyboardKit Pro must only be linked to the main app target. A keyboard extension will still be able to use it by just importing KeyboardKitPro where needed.
## Getting started
The easiest way to set up KeyboardKit is to first create a `KeyboardApp` value for your app:
```swift
import KeyboardKitPro
extension KeyboardApp {
static var keyboardKitDemo: KeyboardApp {
.init(
name: "KeyboardKit",
licenseKey: "your-key-here", // Required by 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()
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,
services: controller.services,
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 {
KeyboardAppView(for: .keyboardKitDemo) {
ContentView()
}
}
}
}
```
For more information, see the [getting started guide][Getting-Started] and [essentials][Essentials] articles.
## Localization
KeyboardKit supports [72 locales][Localization]:
๐บ๐ธ ๐ฆ๐ฑ ๐ฆ๐ช ๐ฆ๐ฒ ๐ง๐พ ๐ง๐ฌ ๐ฆ๐ฉ ๐ณ๏ธ ๐ณ๏ธ ๐ญ๐ท
๐จ๐ฟ ๐ฉ๐ฐ ๐ณ๐ฑ ๐ง๐ช ๐ฆ๐บ ๐จ๐ฆ ๐ฌ๐ง ๐บ๐ธ ๐ช๐ช ๐ซ๐ด
๐ต๐ญ ๐ซ๐ฎ ๐ซ๐ท ๐จ๐ฆ ๐ง๐ช ๐จ๐ญ ๐ฌ๐ช ๐ฉ๐ช ๐ฆ๐น ๐จ๐ญ
๐ฌ๐ท ๐บ๐ธ ๐ฎ๐ฑ ๐ญ๐บ ๐ฎ๐ธ ๐ณ๏ธ ๐ฎ๐ฉ ๐ฎ๐ช ๐ฎ๐น ๐ฐ๐ฟ
๐น๐ฏ ๐น๐ฏ ๐น๐ฏ ๐ฑ๐ป ๐ฑ๐น ๐ฒ๐ฐ ๐ฒ๐พ ๐ฒ๐น ๐ฒ๐ณ ๐ณ๏ธ
๐ณ๐ด ๐ณ๐ด ๐ฎ๐ท ๐ต๐ฑ ๐ต๐น ๐ง๐ท ๐ท๐ด ๐ท๐บ ๐ท๐ธ ๐ท๐ธ
๐ธ๐ฐ ๐ธ๐ฎ ๐ช๐ธ ๐ฆ๐ท ๐ฒ๐ฝ ๐ธ๐ช ๐ฐ๐ช ๐น๐ท ๐บ๐ฆ ๐บ๐ฟ
๐ป๐ณ ๐ด๓ ง๓ ข๓ ท๓ ฌ๓ ณ๓ ฟ
KeyboardKit only includes localized strings, whileย KeyboardKit Pro unlocks localized keyboards, layouts, callouts and behaviors for all supported locales.
## Pro Features
[KeyboardKit][KeyboardKit] provides a free, open-source keyboard engine. KeyboardKit Pro unlocks more powerful pro features:
* ๐ฑ [Essentials][Essentials] - More essential tools, previews, toolbars, etc.
* โจ๏ธ [Essentials-KeyboardView][Essentials-KeyboardView] - Make the keyboard view do a lot more.
* ๐ค [AI][AI] - Features that are needed for AI.
* ๐ฑ [App][App] - App-specific screens & views.
* ๐ก [Autocomplete][Autocomplete] - Local & remote autocomplete, next word prediction, etc.
* ๐ฏ [Callouts][Callouts] - Localized callout actions for all supported locales.
* ๐ค [Dictation][Dictation] - Dictate text from the keyboard.
* ๐ [Emojis][Emojis] - A powerful emoji keyboard, search, etc.
* โจ๏ธ [External][External] - Auto-detect if an external keyboard is connected.
* ๐ [Host][Host] - Identify and open specific host applications.
* ๐ฃ [Layout][Layout] - More input sets and layouts for all supported locales.
* ๐ [Localization][Localization] - Services & views for all supported locales.
* ๐ [Previews][Previews] - Keyboard & theme previews for in-app use.
* ๐ [Proxy][Proxy] - Allow `UITextDocumentProxy` to read the full document.
* ๐ [Text][Text-Input] - Allow users to type within the keyboard.
* ๐ญ [Themes][Themes] - A theme engine with many pre-defined themes.
## Documentation
The [online documentation][Documentation] has a thorough getting-started guide, a detailed article for each feature, code samples, etc. You can also build it from the source code to get better formatting.
## Demo App
The [main repository][KeyboardKit] has a demo app that shows how to set up the main keyboard app, show keyboard status, provide in-app settings, link to system settings, apply custom styles, etc.
The app has two keyboards - a `Keyboard` that uses KeyboardKit and a `KeyboardPro` that uses KeyboardKit Pro.
> [!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
Download the [KeyboardKit app][KeyboardKit-App] from the App Store to try KeyboardKit without having to write any code or build the demo app from Xcode.
## 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: [[email protected]][Email]
* Bluesky: [@keyboardkit.bsky.social][Bluesky]
* Mastodon: [@[email protected]][Mastodon]
## Commercial License
KeyboardKit Pro requires a license to be used. You can sign up on the [KeyboardKit website][Website] or the [Gumroad store][Gumroad].
[Email]: mailto:[email protected]
[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]: https://github.com/KeyboardKit/KeyboardKit
[KeyboardKit-App]: https://keyboardkit.com/app
[Pro]: https://github.com/KeyboardKit/KeyboardKitPro
[Gumroad]: https://kankoda.gumroad.com
[License]: https://github.com/KeyboardKit/KeyboardKitPro/blob/master/LICENSE
[Documentation]: https://keyboardkit.github.io/KeyboardKitPro/
[Getting-Started]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/getting-started
[Essentials]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/essentials
[Essentials-KeyboardView]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/essentials-keyboardview
[Essentials-Memory-Management]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/essentials-memory-management
[Actions]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/actions-article
[AI]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/ai-article
[App]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/app-article
[Autocomplete]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/autocomplete-article
[Buttons]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/buttons-article
[Callouts]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/callouts-article
[Device]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/device-article
[Dictation]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/dictation-article
[Emojis]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/emojis-article
[External]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/external-keyboards-article
[Feedback]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/feedback-article
[Gestures]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/gestures-article
[Host]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/host-article
[Layout]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/layout-article
[Localization]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/localization-article
[Navigation]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/navigation-article
[Previews]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/previews-article
[Proxy]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/proxy-article
[Settings]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/settings-article
[Status]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/status-article
[Styling]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/styling-article
[Text-Input]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/text-input-article
[Themes]: https://keyboardkit.github.io/KeyboardKitPro/documentation/keyboardkitpro/themes-article