Overview
iOS keyboard extensions use the native UITextDocumentProxy to interact with the currently active application’s selected text field, e.g. to insert or delete text.
If you have a text field within your keyboard, you therefore need to find a way to route text to that text field instead of the active application.
KeyboardKit adds ways to make this easier. KeyboardInputViewController has a .textInputProxy that can be set to route text to any other text field.
KeyboardKit Pro unlocks even more routing utils, like a KeyboardTextField that automatically lets you type within a keyboard extension by registering and resigning as the main text input proxy.
How does text routing work?
UIInputController has a textDocumentProxy, which is how a keyboard is meant to integrate with the currently active app.
KeyboardInputViewController adds a textInputProxy that can be set to replace textDocumentProxy as the main text document proxy.
Setting textInputProxy will cause any text you type in the keyboard to be sent to that proxy instead. Just set the textInputProxy to nil to start routing text back to the main app.
👑 Pro features
KeyboardKit Pro unlocks text input views that automatically register and unregister themselves as the main text input proxy when they receive and lose focus:
KeyboardTextFieldwraps aUITextFieldand can be used for single-line text inputs.KeyboardTextViewwraps aUITextViewand can be used for multi-line text inputs.
Both views also support SwiftUI FocusState and have a focused view modifier that lets you provide a custom done button that slides in when the view is focused.
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.