Swiftpack.co - KeyboardKit/KeyboardKitPro as Swift Package

About KeyboardKit Pro

KeyboardKit helps you create custom keyboards for iOS and iPadOS, using Swift and SwiftUI. It extends Apple's native keyboard APIs and provides you with more functionality.

KeyboardKit Pro extends KeyboardKit with pro features, such as localized input sets, layouts and callout actions, autocomplete, dictation, proxy extensions, emoji skintone and version info, etc.

KeyboardKit supports iOS 14, macOS 11, tvOS 14 and watchOS 7.

Pricing

KeyboardKit Pro 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

KeyboardKit Pro only has to be added to the main app target.

Supported Locales

KeyboardKit is localized in 60+ keyboard-specific locales:

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

KeyboardKit Pro unlocks localized input sets, layouts and callouts for all locales.

Features

KeyboardKit Pro extends KeyboardKit with a bunch of features:

• 💡 Autocomplete - KeyboardKit Pro unlocks a local and a remote autocomplete provider.
• 🗯 Callouts - KeyboardKit Pro unlocks locale-specific callout actions for all locales.
• 🎤 Dictation - (BETA) KeyboardKit unlocks a dictation engine that can perform keyboard dictation.
• 😊 Emojis - KeyboardKit Pro unlocks emoji skin tone variants, secondary actions and version information.
• 🔣 Layout - KeyboardKit Pro unlocks locale-specific input sets and keyboard layouts for all locales.
• ➡️ Proxy Extensions - KeyboardKit Pro unlocks UITextDocumentProxy extensions for reading all text from the proxy.
• 🎨 Styling - KeyboardKit Pro unlocks a theme-based appearance engine with many pre-defined themes.

Getting started

The online documentation has a getting-started guide that helps you get started.

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

import KeyboardKitPro

class KeyboardController: KeyboardInputViewController {}

This gives your controller access to additional functionality, such as new lifecycle functions like viewWillSetupKeyboard(), observable state like keyboardContext, services like keyboardActionHandler and much more.

The default KeyboardInputViewController behavior is to setup an English SystemKeyboard. It will then call viewWillSetupKeyboard() when the keyboard view should be created or updated.

If you want to use the default system keyboad with the locales and features that your license unlocks, you can just register your license key:

func viewDidLoad() {
    super.viewDidLoad()
    let license = try? setupPro(withLicenseKey: "your-key")
}

To set up KeyboardKit Pro with a custom view, you can override viewWillSetupKeyboard() and call setupPro(withLicenseKey:licenseConfiguration:view:) to customize the SystemKeyboard or use a custom view:

class KeyboardViewController: KeyboardInputViewController {

    override func viewWillSetupKeyboard() {
        super.viewWillSetupKeyboard()
        try? setupPro(
            withLicenseKey: "LICENSE-KEY",
            licenseConfiguration: { license in
                // Use the license as needed here
            },
            view: { controller in
                VStack(spacing: 0) {
                    MyCustomToolbar()
                    SystemKeyboard(
                        controller: controller,
                        autocompleteToolbar: .none
                    )
                }
            }
        )
    }
}

The view builder provides an unowned controller reference to avoid reference cycles and memory leaks.

For more information, please see the online documentation and getting-started guide.

Documentation

The online documentation has articles, code examples etc. that let you overview the various parts of the library and understand how they all connect to each other.

The online documentation is currently iOS-specific, which means that some parts will not be available if you run KeyboardKit Pro on other platforms.

Demo Application

The main project repository has a demo app that lets you try out KeyboardKit and KeyboardKit Pro.

• The main app shows how to display keyboard state, link to system settings, etc.
• The English keyboard uses KeyboardKit and a SystemKeyboard with a standard, English locale.
• The Unicode keyboard uses KeyboardKit and a SystemKeyboard with unicode-based input keys.
• The Custom keyboard uses KeyboardKit and a SystemKeyboard with custom keys, layouts and styles.
• The Pro keyboard uses KeyboardKit Pro and a SystemKeyboard with all LRT locales, autocomplete etc.

Just open and run the demo app in the Demo folder, then enable the keyboards you want to try under System Settings. Note that you need to enable full access to try some features, like audio and haptic feedback.

Support

KeyboardKit is open-source and completely free, but you can sponsor this project on GitHub Sponsors, upgrade to [KeyboardKit Pro][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 Pro is closed source. See the LICENSE file for more info.