App Utilities

KeyboardKit provides main app utils that lets you build a great main app for your custom keyboard.

The main app is a perfect place to onboard users. With its full screen estate, it’s also a great place to provide the user with keyboard settings, and perform certain operations like dictation.

KeyboardKit has a KeyboardApp struct that is also a namespace for app-related types and views, like KeyboardKit Pro’s HomeScreen, SettingsScreen, LocaleScreen, and ThemesScreen components.

You can create an app-specific KeyboardApp to define your app name, appGroupId, licenseKey, etc.

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 set up your keyboard extension by passing in the KeyboardApp into the setup function, and set up the main app with the same configuration by passing it into a root KeyboardAppView.

👑 KeyboardKit Pro

KeyboardKit Pro unlocks a KeyboardApp.HomeScreen that can be used as the main app’s root view, as well as a SettingsScreen, LocaleScreen, and ThemeScreen that are linked to from the home screen:

These settings screens can be used independently as well, in case you have a custom home screen, and let you add complex and customizable settings to your app with a few lines of code.

Documentation

The information on this page is shortened to be easier to overview. For more information, see the online documentation, or the KeyboardKit Pro documentation.