UIInputViewController
The primary view controller for a custom keyboard app extension.
Declaration
@MainActor class UIInputViewControllerMentioned in
Overview
To create a custom keyboard, first subclass the UIInputViewController class, then add your keyboard’s user interface to the inputView property of your subclass. In Xcode, you can start a custom keyboard by choosing the Custom Keyboard target template.
A custom keyboard can respond to user input events in the following ways:
Add text in the form of an unattributed NSString object at the insertion point in the current text input object, by calling the insertText(_:) method on the textDocumentProxy property. This property provides that method through its conformance to the UIKeyInput protocol
Delete text in a backward direction, starting at the insertion point, by calling the deleteBackward() method on the textDocumentProxy property.
Switch to another keyboard in the set of user-enabled keyboards, by calling the advanceToNextInputMode() method.
Dismiss the keyboard, by calling the dismissKeyboard() method.
Obtain textual context around the insertion point by reading the textDocumentProxy properties documentContextBeforeInput and documentContextAfterInput. To find out if the current text input object is empty, call the hasText method on the textDocumentProxy property. You can employ this textual context by considering it along with user input, to offer context-sensitive output to a document from your keyboard.
An input view controller conforms to the UITextInputDelegate protocol, allowing you to respond to changes in document content and position of the insertion point.
To present an appropriate keyboard layout, respond to the current text input object’s UIKeyboardType property. For each keyboard type trait you support, change the contents of your primary view accordingly.
For more about creating a custom keyboard, read Custom Keyboard in App Extension Programming Guide.