App Utilities

KeyboardKit provides main app utilities to let you build a great main app for your custom keyboard.

Keyboard App

The main app is a perfect place to onboard users, provide keyboard settings, and to perform certain operations, like dictation, that a custom keyboard can’t perform.

KeyboardKit has a KeyboardApp struct that is also a namespace for app-related types and views, that can be used in the main app. You can create an app-specific KeyboardApp value to define your app’s configuration.

extension KeyboardApp {

    static var keyboardKitDemo: KeyboardApp {
        .init(
            name: "KeyboardKit",
            licenseKey: "your-key-here",                // Sets up 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
        )
    }
}

You can then use the value to set up your main app and keyboard extension to use the same config.

Keyboard App View

The KeyboardAppView can be used as the main app’s root content view, and will set up KeyboardKit in the same way as the KeyboardInputViewController’s setup(for:) function does.

KeyboardKit Pro

KeyboardKit Pro unlocks a HomeScreen template that can be used as the main app’s root view, as well as a Keyboard.SettingsScreen, Keyboard.LocaleSettingsScreen, etc.:

Most features have their own settings screens that can be used in the main app and the keyboard:

These screens can be customized and localized to great extent, using their various, convenient view modifiers.

Documentation

The information on this page has been shortened to be easier to overview and keep up to date. For a complete feature description, see the online documentation.