KeyboardKit is a SwiftUI SDK that lets you create fully customizable keyboard extensions with a few lines of code.

KeyboardKit extends Apple's limited keyboard APIs, extends the input controller and proxy with more capabilities, and provides you with additional functionality, states and views, to let you build an outstanding, custom keyboards.

KeyboardKit is open-source and completely free. It can be extended with KeyboardKit Pro to unlock Pro features, like localized keyboards, autocomplete & autocorrect, AI support, an emoji keyboard, themes, dictation, and more.

KeyboardKit can be installed with the Swift Package Manager:

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

After installing KeyboardKit, make sure to link it to all targets that need it.

To use KeyboardKit in a keyboard extension, just inherit the KeyboardKit KeyboardInputViewController instead of UIInputViewController:

import KeyboardKit

class KeyboardController: KeyboardInputViewController {}

This gives your controller access to new lifecycle functions like viewWillSetupKeyboard, observable state like state.keyboardContext, services like services.actionHandler, and much more.

If you just want to use the standard KeyboardView, which mimics a native iOS keyboard, you don't have to do anything else. KeyboardKit will set up an English keyboard for you.

To replace or customize the standard KeyboardView, just override viewWillSetupKeyboard and call setup with the view you want to use:

class KeyboardViewController: KeyboardInputViewController {

    override func viewWillSetupKeyboard() {
        super.viewWillSetupKeyboard()
        setup { [weak self] controller in // <-- Use [weak self] or [unowned self] if you need self here.
            KeyboardView(
                state: controller.state,
                services: controller.services,
                buttonContent: { $0.view },
                buttonView: { $0.view },
                emojiKeyboard: { $0.view },
                toolbar: { _ in MyCustomToolbar() }
            )
        }
    }
}

For more information, please see the getting started guide.

KeyboardKit supports 68 keyboard-specific locales:

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

KeyboardKit only includes built-in support for English, while KeyboardKit Pro unlocks localized keyboards, layouts, callouts and behaviors for all supported locales.

KeyboardKit comes packed with free, open-source features to help you build amazing custom keyboards:

• ⌨️ Essentials - Essential utilities, models, services & views.
• 💥 Actions - Trigger & handle keyboard-related actions.
• 💡 Autocomplete - Perform autocomplete as the user types.
• 🗯 Callouts - Show input & secondary action callouts as the user types.
• 🖥️ Device - Identify the device type, device capabilities, etc.
• 😀 Emojis - Emojis, categories, versions, skin tones, etc.
• 🔉 Feedback - Trigger audio & haptic feedback with ease.
• 👆 Gestures - Handle a rich set of gestures on any key.
• 🏠 Host - Easily can identify the host application.
• 🔣 Layout - Easily define and customize the keyboard layout.
• 🌐 Localization - Localize your keyboard in all supported locales.
• 🗺️ Navigation - Open urls and other apps from the keyboard.
• 👁 Previews - Extensive keyboard preview support.
• ➡️ Proxy - Extend the text document proxy with a lot more capabilities.
• ⚙️ Settings - Easily provide in-app settings & link to System Settings.
• 🩺 Status - Detect if a keyboard is enabled, has full access, etc.
• 🎨 Styling - Style your keyboard to great extent.

KeyboardKit Pro extends KeyboardKit with Pro features:

• ⌨️ Essentials - Unlock more essential tools, keyboard previews, etc.
• 🤖 AI - Unlock features that are needed for AI.
• 📱 App - Unlock app-specific screens & views.
• 💡 Autocomplete - Unlock on-device & remote autocomplete for many locales.
• 🗯 Callouts - Unlock localized callouts for all locales.
• 🎤 Dictation - Make your keyboard perform dictation via the main app.
• 😀 Emojis - Unlock a powerful emoji keyboard.
• ⌨️ External - Detect if an external keyboard is connected.
• 🏠 Host - Easily identify and open specific host applications.
• 🔣 Layout - Unlock localized layouts for all locales.
• 🌐 Localization - Unlock locale-specific services & views.
• 👁 Previews - Unlock keyboard & theme previews.
• ➡️ Proxy - Unlock ways for UITextDocumentProxy to read the full document.
• 📝 Text - Unlock tools to let users type within the keyboard.
• 🍭 Themes - Unlock a theme engine with many pre-defined themes.

The online documentation has more information, articles, code examples, etc.

The demo app shows you how to customize the keyboard, show keyboard state, provide in-app settings in the main app, 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.

Just open and run the demo app in the Demo folder, then enable the keyboards under System Settings. Note that you need to enable Full Access for some features to work, like haptic feedback.

If you want to try KeyboardKit without having to write any code or build the demo app from Xcode, the KeyboardKit app lets you try out many features by just downloading it from the App Store.

KeyboardKit is open-source and completely free, but you can support the project by becoming a GitHub Sponsor, upgrading to KeyboardKit Pro or get in touch for freelance work, paid support etc.

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

• Website: keyboardkit.com
• Mastodon: @[email protected]
• Twitter: @getkeyboardkit
• E-mail: [email protected]

KeyboardKit is available under the MIT license. See the LICENSE file for more info.