KeyboardKitPro

KeyboardKitPro copied to clipboard

About KeyboardKit Pro

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 Pro extends KeyboardKit with pro features like fully localized keyboards & services, autocomplete, an emoji keyboard, AI supporting capabilities, themes, dictation, and much more.

Commercially Licensed

KeyboardKit Pro is closed source and requires a commercial license.

Licenses can be purchased from the website or from Gumroad.

Installation

KeyboardKit Pro can be installed with the Swift Package Manager:

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

Important! Unlike KeyboardKit, KeyboardKit Pro is a binary target and must only be added to the app target. If you add it to any other target, it may crash at runtime.

Getting started

After installing KeyboardKit Pro, just make your KeyboardViewController inherit KeyboardInputViewController instead of UIInputViewController:

import KeyboardKitPro

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 and updates when the observable state changes, you only have to register your license key:

func viewDidLoad() {
    super.viewDidLoad()
    let license = try? setupPro(
        withLicenseKey: "your-key",
        locales: [...], // Define which locales to use 
    ) { license in
        // Make any license-based configurations here 
    }
}

To replace or customize the default SystemKeyboard, just override viewWillSetupKeyboard and call setupPro:

class KeyboardViewController: KeyboardInputViewController {

    override func viewWillSetupKeyboard() {
        super.viewWillSetupKeyboard()
        try? setupPro(
            withLicenseKey: "your-key",
            locales: [...], // Define which locales to use
            licenseConfiguration: { license in
                // Make any configurations and service adjustments here
            },
            view: { controller in
                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 and callout actions, while KeyboardKit Pro provides localized layouts, callouts and behaviors for all supported locales.

Features

KeyboardKit Pro extends KeyboardKit with pro features:

• ⌨️ Essentials - KeyboardKit Pro unlocks more essential tools, system keyboard previews, etc.
• 💥 Actions - KeyboardKit Pro keeps the .frequent emoji category in sync.
• 🤖 AI Support - KeyboardKit Pro unlocks tools that are required for AI-based features.
• 💡 Autocomplete - KeyboardKit Pro unlocks a local and a remote autocomplete.
• 🗯 Callouts - KeyboardKit Pro unlocks callout actions for every supported locale.
• 🎤 Dictation - KeyboardKit Pro unlocks pre-defined dictation services and a speech recognizer.
• 😀 Emojis - KeyboardKit Pro unlocks a powerful emoji keyboard.
• ⌨️ External Keyboards - KeyboardKit Pro unlocks ways to detect and react to external keyboards.
• 🔉 Feedback - KeyboardKit Pro unlocks components for toogling feedback on & off.
• 🔣 Layout - KeyboardKit Pro unlocks input sets and layouts for every supported locale.
• 🌐 Localization - KeyboardKit Pro supports all 63 locales.
• 👁️ Previews - KeyboardKit Pro unlocks system keyboard previews that can be used in the app.
• ➡️ Proxy Extensions - KeyboardKit Pro unlocks ways to read the full document.
• 🚏 Text Routing - KeyboardKit Pro unlocks views that let you type within the keyboard.
• 🍭 Themes - KeyboardKit Pro unlocks a theme engine with many pre-defined themes.

Documentation

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

Demo App

The KeyboardKit repository has a demo app that 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.

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]

Commercially Licensed

KeyboardKit Pro is closed source. See the LICENSE file for more info.

Commercial licenses can be purchased from the website or from Gumroad.