The primary view controller for a custom keyboard app extension.
- iOS 8.0+
- Mac Catalyst 13.0+
- tvOS 9.0+
To create a custom keyboard, first subclass the
UIInput class, then add your keyboard’s user interface to the
input 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
NSStringobject at the insertion point in the current text input object, by calling the
insertmethod on the
textproperty. This property provides that method through its conformance to the
Switch to another keyboard in the set of user-enabled keyboards, by calling the
To Next Input Mode
Dismiss the keyboard, by calling the
Obtain textual context around the insertion point by reading the
document. To find out if the current text input object is empty, call the
has method on the
text 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
UIText 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
UIKeyboard property. For each keyboard type trait you support, change the contents of your primary view accordingly.