Overview
Great keyboard apps use the main app to show the user the state of the keyboard, if it’s enabled in System Settings, if Full Access is enabled, etc.
The app should also let the user easily navigate to System Settings to enable the keyboard, enable Full Access, etc.
KeyboardKit adds utilities to make this easier, such as URL extensions and navigation links.
System Settings
KeyboardKit has a .keyboardSettings URL extension that can be used to open your app’s keyboard settings in System Settings.
If your keyboard randomly navigates to the System Settings root instead of your app, try adding an empty settings bundle to your app.
A common request is to access various settings from System Settings, for instance the user’s autocapitalization and autocorrect preferences.This is not possible, at least not with the public APIs.
Share settings between the app and the keyboard
Many keyboard extensions open the main app to let users access settings. The larger UI makes for a great alternative for app and keyboard settings.
To share data between the app and the keyboard, you must use an App Group to persist data in a way that allows it to be accessed by both the app and the keyboard.
The main app will always write data to an App Group in a way that makes it instantly available to the keyboard. A keyboard must however have Full Access enabled for data to be immediately synced.
Documentation
The information on this page has been shortened to be easier to overview. For more information about this feature, code samples, etc. please see the online documentation.
Read more
Essentials
KeyboardKit provides essential features, utilities & views.
Actions
KeyboardKit makes it easy to trigger keyboard-related actions
Autocomplete
KeyboardKit can perform autocomplete.
Callouts
KeyboardKit can show input & secondary action callouts.
Colors
KeyboardKit defines keyboard-specific colors.
Device Utilities
KeyboardKit has device-specific utilities.
Emojis
KeyboardKit defines emojis, categories, skin tones, etc.
Feedback
KeyboardKit can trigger audio & haptic feedback.
Gestures
KeyboardKit has a customizable keyboard gesture engine.
Images
KeyboardKit defines keyboard-specific images.
Layout
KeyboardKit has customizable input sets & keyboard layouts.
Localization
KeyboardKit supports 60+ locales and languages.
Navigation
KeyboardKit lets you open urls and apps from the keyboard.
Previews
KeyboardKit has rich SwiftUI preview support.
Proxy Utilities
KeyboardKit makes your text document proxy do a LOT more.
Settings
KeyboardKit has tools for in-app settings & System Settings.
Status
KeyboardKit detects if a keyboard is enabled, has full access, etc.
Styling
KeyboardKit lets you style your keyboards to great extent.
Text Routing
KeyboardKit kan route text to other places.
Pro Features
Essentials
KeyboardKit Pro unlocks system keyboard and theme previews.
Actions
KeyboardKit Pro auto-registers the most recently used emojis.
AI Support
KeyboardKit Pro unlocks features that are needed for AI.
App
KeyboardKit Pro unlocks app-specific screens & views.
Autocomplete
KeyboardKit Pro unlocks on-device & remote autocomplete.
Callouts
KeyboardKit Pro unlocks localized callouts for all locales.
Dictation
KeyboardKit Pro can perform dictation from the keyboard.
Emojis
KeyboardKit Pro unlocks an emoji keyboard with skintone support.
External Keyboards
KeyboardKit Pro can detect if an external keyboard is connected.
Feedback
KeyboardKit Pro unlocks tools for toogling feedback on & off.
Layout
KeyboardKit Pro unlocks localized layouts for all locales.
Localization
KeyboardKit Pro unlocks support for 60+ locales.
Previews
KeyboardKit Pro unlocks system keyboard and theme previews.
Proxy Utilities
KeyboardKit Pro makes the proxy able to read the full document.
Text Input
KeyboardKit Pro unlocks tools to let you type within the keyboard
Themes
KeyboardKit Pro unlocks a theme engine & many standard themes.