App

Overview

KeyboardKit provides utilities that are meant to be used in the main app target, to build a great app that can provide the user with settings, configurations, etc.

Keyboard App

KeyboardKit has a KeyboardApp struct that is also a namespace for app-related types and views, like the HomeScreen, SettingsScreen and LocaleScreen screens that are unlocked with KeyboardKit Pro.

You can create an app-specific KeyboardApp value to define your app’s name, bundleId, appGroupId, licenseKey, deepLinks, etc.

extension KeyboardApp {

    static var keyboardKitDemo: Self {
        .init(
            name: "KeyboardKit",
            licenseKey: "abc123",
            bundleId: "com.keyboardkit.demo",
            appGroupId: "group.com.keyboardkit.demo"
        )
    }
}

Your app-specific KeyboardApp can also resolve other properties that you may need, e.g. to perform keyboard-based dictation, enable AI-based next word prediction, etc.

Keyboard App View

The KeyboardAppView view can be used as the root view of the main app target, to set up everything it needs to use KeyboardKit for a certain KeyboardApp:

@main
struct MyApp: App {
    var body: some Scene {
        WindowGroup {
            KeyboardAppView(for: .myApp) {
                ContentView()
            }
        }
    }
}

This will set up things that are defined by the app, like making keyboard setting use an App Group to sync between the app and keyboard, register a KeyboardKit Pro license key, set up dictation, etc.

👑 Pro Features

KeyboardKit Pro unlocks a KeyboardApp.HomeScreen that can be used by a main keyboard app target, as well as SettingsScreen, LocaleScreen, and ThemeScreen settings screens:

These screens lets you add complex, yet customizable, app screens to your main app with a single line of code. Each screen can be customized, using convenient view modifiers.

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.