KeyboardKit lets you create amazing custom keyboard extensions 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 below.
KeyboardKit Pro requires a license to be used. You can sign up on the KeyboardKit website or the Gumroad store.
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.
The easiest way to set up KeyboardKit is to first create a KeyboardApp value for your app:
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:
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:
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:
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:
@main
struct MyApp: App {
var body: some Scene {
WindowGroup {
// Here we use the `.keyboardKitDemo` from above
KeyboardAppView(for: .keyboardKitDemo) {
ContentView()
}
}
}
}For more information, see the getting started guide and essentials articles.
KeyboardKit supports 73 locales:
🇺🇸 🇦🇱 🇦🇪 🇦🇲 🇧🇾 🇧🇬 🇦🇩 🏳️ 🏳️ 🇭🇷
🇨🇿 🇩🇰 🇳🇱 🇧🇪 🇦🇺 🇨🇦 🇬🇧 🇺🇸 🇪🇪 🇫🇴
🇵🇭 🇫🇮 🇫🇷 🇨🇦 🇧🇪 🇨🇭 🇬🇪 🇩🇪 🇦🇹 🇨🇭
🇬🇷 🇺🇸 🇮🇱 🇭🇺 🇮🇸 🏳️ 🇮🇩 🇮🇪 🇮🇹 🇰🇿
🇹🇯 🇹🇯 🇹🇯 🇱🇻 🇱🇹 🇲🇰 🇲🇾 🇲🇹 🇲🇳 🏳️
🇳🇴 🇳🇴 🇮🇷 🇵🇱 🇵🇹 🇧🇷 🇷🇴 🇷🇺 🇷🇸 🇷🇸
🇸🇰 🇸🇮 🇪🇸 🇦🇷 🇲🇽 🇸🇪 🇰🇪 🇹🇷 🇺🇦 🇺🇿
🇺🇿 🇻🇳 🏴
KeyboardKit only includes localized strings, while KeyboardKit Pro unlocks localized keyboards, layouts, callouts and behaviors for all supported locales.
KeyboardKit provides a free, open-source keyboard engine. KeyboardKit Pro unlocks more powerful pro features:
- 🌱 Essentials - More essential tools, previews, toolbars, etc.
- ⌨️ Essentials-KeyboardView - Make the keyboard view do a lot more.
- 🤖 AI - Features that are needed for AI.
- 📱 App - App-specific screens & views.
- 💡 Autocomplete - Local & remote autocomplete, next word prediction, etc.
- 🗯 Callouts - Localized callout actions for all supported locales.
- 🎤 Dictation - Dictate text from the keyboard.
- 😀 Emojis - A powerful emoji keyboard, search, etc.
- ⌨️ External - Auto-detect if an external keyboard is connected.
- 🏠 Host - Identify and open specific host applications.
- 📝 Input - Keyboard input fields, Vietnamese support, etc.
- 🔣 Layout - More input sets and layouts for all supported locales.
- 🌐 Localization - Services & views for all supported locales.
- 👁 Previews - Keyboard & theme previews for in-app use.
- 📄 Proxy - Allow
UITextDocumentProxyto read the full document. - 🍭 Themes - A theme engine with many pre-defined themes.
The online 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.
The main repository 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.
Download the KeyboardKit app from the App Store to try KeyboardKit without having to write any code or build the demo app from Xcode.
Feel free to reach out if you have questions or if you want to contribute in any way:
- Website: keyboardkit.com
- E-mail: info@keyboardkit.com
- Bluesky: @keyboardkit.bsky.social
- Mastodon: @keyboardkit@techhub.social
KeyboardKit Pro requires a license to be used. You can sign up on the KeyboardKit website or the Gumroad store.