Text Document Proxy Utilities

Custom keyboards use a text document proxy to integrate with the currently active text field. It lets you insert and delete text, get the selected text, move the input cursor, etc.

The native proxy APIs are however very limited, which makes it hard to get information about the text and to perform many common keyboard operations.

KeyboardKit extends the proxy with more features to let you do more, like getting the currentWord and info like isCursorAtNewSentence, and to deleteBackward(range:), endSentence(withText:), etc.

👑 KeyboardKit Pro

KeyboardKit Pro unlocks additional text document proxy capabilities, like the ability to read the full document context, instead of the limited text that the native APIs return.

let proxy = keyboardContext.textDocumentProxy
let result = try await proxy.fullDocumentContext(...)

KeyboardKit Pro also makes it possible to replace the main text document proxy with a custom one. This is used by the text input components, to let you type within the keyboard extension.

Documentation

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

Features

KeyboardKit has a lot of core features. You can upgrade to KeyboardKit Pro to unlock pro features. Features that are marked with pro below are exclusive to KeyboardKit Pro.