About KeyboardKit

KeyboardKit is a Swift SDK that lets you create fully customizable keyboards in a few lines of code, using SwiftUI.

KeyboardKit extends Apple's native APIs and provides you with a lot more functionality. It lets you mimic the native iOS keyboard and tweak its style and behavior, or create completely custom keyboards.

Custom iOS keyboard extensions can be used with all other apps that support text input. It's the only way for your product, brand or technology to directly interact with other apps on iOS. Don't miss out!

KeyboardKit can be used in different ways. Keyboard extensions can use it to create custom keyboards. Apps can use it to check keyboard and full access status, provide settings etc.

Installation

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.

Getting Started

After installing KeyboardKit, just make your KeyboardViewController inherit 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 default SystemKeyboard view, which mimics a native iOS keyboard, you don't have to do anything else. KeyboardKit will set up everything.

To replace or customize the default SystemKeyboard, just override viewWillSetupKeyboard and call setup with a view builder:

class KeyboardViewController: KeyboardInputViewController {

    override func viewWillSetupKeyboard() {
        super.viewWillSetupKeyboard()
        setup { [weak self] controller in // <-- Use [weak self] or [unowned self] if you need self here.
            SystemKeyboard(
                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.

Supported Locales

KeyboardKit supports 63 keyboard-specific locales:

🇦🇱 🇦🇪 🇦🇲 🇧🇾 🇧🇬 🇦🇩 🏳️ 🇭🇷 🇨🇿 🇩🇰
🇳🇱 🇧🇪 🇺🇸 🇬🇧 🇺🇸 🇪🇪 🇫🇴 🇵🇭 🇫🇮 🇫🇷
🇧🇪 🇨🇭 🇬🇪 🇩🇪 🇦🇹 🇨🇭 🇬🇷 🇺🇸 🇮🇱 🇭🇺
🇮🇸 🏳️ 🇮🇩 🇮🇪 🇮🇹 🇰🇿 🇹🇯 🇹🇯 🇹🇯 🇱🇻
🇱🇹 🇲🇰 🇲🇾 🇲🇹 🇲🇳 🇳🇴 🏳️ 🇮🇷 🇵🇱 🇵🇹
🇧🇷 🇷🇴 🇷🇺 🇷🇸 🇷🇸 🇸🇰 🇸🇮 🇪🇸 🇰🇪 🇸🇪
🇹🇷 🇺🇦 🇺🇿

KeyboardKit provides a basic keyboard layout with basic callout actions. KeyboardKit Pro provides localized layouts, callouts and behaviors for all supported locales.

Open-Source Features

KeyboardKit comes packed features to help you build amazing keyboard extensions:

• ⌨️ Essentials - KeyboardKit provides essential utilities, types & views.
• 💥 Actions - KeyboardKit makes it easy to trigger keyboard-related actions.
• 💡 Autocomplete - KeyboardKit can perform autocomplete.
• 🗯 Callouts - KeyboardKit can show input & secondary action callouts.
• 🌈 Colors - KeyboardKit defines keyboard-specific colors.
• 🖥️ Device - KeyboardKit has device-specific utilities.
• 😀 Emojis - KeyboardKit defines emojis, categories, versions, skin tones, etc.
• 🔉 Feedback - KeyboardKit can trigger audio & haptic feedback.
• 👆 Gestures - KeyboardKit has a customizable keyboard gesture engine.
• 🖼️ Images - KeyboardKit defines keyboard-specific images.
• 🔣 Layout - KeyboardKit has customizable input sets & keyboard layouts.
• 🌐 Localization - KeyboardKit defines localized texts & assets for 63 locales.
• 🗺️ Navigation - KeyboardKit lets you open urls and apps from the keyboard.
• 👁 Previews - KeyboardKit has extensive SwiftUI preview support.
• ➡️ Proxy - KeyboardKit extends UITextDocumentProxy with a lot more capabilities.
• ⚙️ Settings - KeyboardKit has tools for in-app settings & System Settings.
• 🩺 Status - KeyboardKit can detect if a keyboard is enabled, has full access, etc.
• 🎨 Styling - KeyboardKit lets you style your keyboards to great extent.

These features are all open-source and free to use. You can upgrade to KeyboardKit Pro to unlock Pro features.

KeyboardKit Pro

KeyboardKit Pro unlocks Pro features, like fully localized and locale-specific system keyboards, layouts & services, on-device and remote autocomplete & autocorrect, dictation, themes, etc.

• ⌨️ Essentials - KeyboardKit Pro unlocks more essential tools, system keyboard previews, etc.
• 💥 Actions - KeyboardKit Pro auto-registers the most recently used emojis.
• 🤖 AI - KeyboardKit Pro unlocks features that are needed for AI.
• 📱 App - KeyboardKit Pro unlocks app-specific screens & views.
• 💡 Autocomplete - KeyboardKit Pro unlocks on-device & remote autocomplete.
• 🗯 Callouts - KeyboardKit Pro unlocks localized callouts for all locales.
• 🎤 Dictation - KeyboardKit Pro can perform dictation from the keyboard.
• 😀 Emojis - KeyboardKit Pro unlocks a powerful emoji keyboard.
• ⌨️ External - KeyboardKit Pro can detect if an external keyboard is connected.
• 🔉 Feedback - KeyboardKit Pro unlocks tools for toogling feedback on & off.
• 🔣 Layout - KeyboardKit Pro unlocks localized layouts for all locales.
• 🌐 Localization - KeyboardKit Pro unlocks 63 locale-specific services and system keyboards.
• 👁 Previews - KeyboardKit Pro unlocks system keyboard and theme previews.
• ➡️ Proxy - KeyboardKit Pro unlocks ways for UIKit/UITextDocumentProxy to read the full document.
• 📝 Text - KeyboardKit Pro unlocks tools to let you type within the keyboard.
• 🍭 Themes - KeyboardKit Pro unlocks a theme engine with many pre-defined themes.

Every article in the documentation describes in detail what KeyboardKit Pro unlocks for that part of the SDK.

Documentation

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

Demo App

The demo app shows how to display keyboard state, link to system settings, etc.

The demo app has two demo keyboards:

• Keyboard uses KeyboardKit and a customized SystemKeyboard.
• KeyboardPro uses KeyboardKit Pro and enables all locales, autocomplete, themes, etc.

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.

KeyboardKit App

If you want to try KeyboardKit Pro without having to write any code or build the demo app from Xcode, there is a KeyboardKit app in the App Store, that lets you try out many pro features.

Support This Project

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.

Contact

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]

License

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