Skip to content

Keyboard Format

Keyboard Format

Keyboard formats define the on-screen keyboard of a Text Entry user interface. Each layout is a list of keys separated by spaces, and any text that is not a special code is a key that types that text.

Keys are added to the Keyboard Element in order, so line breaks are only for readability; the element's list layout decides how the keys wrap into rows.

Special Codes

Code Default Label Description
<backspace> Back Removes the last character.
<cancel> Cancel Cancels the text entry.
<clear> Clear Clears the entered text.
<confirm> OK Confirms the entered text.
<reset> Reset Restores the text to its initial value.
< > (Space) Types a space.
<layout[Name]> Name Switches to the layout with the given name. <layout> returns to the default layout, labeled Default.
<> (Empty) Adds an empty key that does nothing, for spacing.
<< < Types a <.

Custom Labels

Every special code accepts a label in brackets to replace its default text, such as <confirm[Done]> or <backspace[Delete]>. Labels may contain spaces.

The layout code takes the layout name first, followed by an optional label after a pipe, such as <layout[Symbols|More...]>.

Special codes are not case-sensitive.