Overview
A keyboard extension should be able to detect if an external keyboard is connected, since it makes it stop working as expected. For instance, the text document proxy will not update properly.
KeyboardKit Pro unlocks tools to help you detect if an external keyboard is connected, and ways to automatically collapse the keyboard into a compressed view.
Context
KeyboardKit has an ExternalKeyboardContext
that has state for if an external keyboard is connected, such as a Smart Keyboard Folio, a Magic Keyboard, any Bluetooth keyboards, etc.
KeyboardKit Pro automatically keeps this context in sync when an external keyboard is connected and disconnected. Without it, you must listen for changes and update the context yourself.
How to collapse the keyboard
The KeyboardContext.isKeyboardCollapsed
property can be used to collapse and expand a keyboard as an external keyboard is connected. KeyboardKit Pro will automatically update this value.
The KeyboardView
lets you define which view to show when the keyboard is collapsed. This lets you explain why the user can’t use your keyboard while an external one is connected.
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.
Core Features
KeyboardKit is packed with features. You can upgrade to KeyboardKit Pro to unlock pro features.
Essentials
KeyboardKit provides essential features, utilities & views.
Actions
KeyboardKit makes it easy to handle keyboard actions.
App
KeyboardKit makes it easy to set up your app and its keyboard.
Callouts
KeyboardKit can show input and secondary action callouts.
Emojis
KeyboardKit defines emojis, emoji categories, skin tones, etc.
Feedback
KeyboardKit can trigger audio & haptic feedback.
Gestures
KeyboardKit can trigger & handle rich keyboard gestures.
Layout
KeyboardKit has fully dynamic & customizable layout engine.
Localization
KeyboardKit supports 70 locales, with localized resources.
Navigation
KeyboardKit lets you open urls and apps from the keyboard.
Previews
KeyboardKit has built-in support for SwiftUI previews.
Proxy Utilities
KeyboardKit lets the 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.
👑 Pro Features
KeyboardKit Pro unlocks powerful pro features to take your keyboard extension to the next level.
Essentials
KeyboardKit Pro unlocks more essential views & utilities.
AI Support
KeyboardKit Pro unlocks features that are needed for AI.
App
KeyboardKit Pro unlocks app-specific screens & views.
Autocomplete
KeyboardKit Pro unlocks local & remote autocomplete.
Callouts
KeyboardKit Pro unlocks callout actions for all locales.
Dictation
KeyboardKit Pro can trigger dictation from the keyboard.
Emoji Keyboard
KeyboardKit Pro unlocks an emoji keyboard & search capabilities.
External Keyboards
KeyboardKit Pro can detect if an external keyboard is being used.
Host
KeyboardKit Pro can identify and open specific host applications.
Layout
KeyboardKit Pro unlocks input sets & layouts for all locales.
Localization
KeyboardKit Pro unlocks support for 70 locales.
Previews
KeyboardKit Pro unlocks in-app keyboard & 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.