Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Class KeyboardProperties

Struct for keyboard properties defining the capabilities and behavior of the keyboard

Hierarchy

  • KeyboardProperties

Index

Constructors

constructor

Properties

cancelLabel

cancelLabel: CancelLabel

Label to use for a cancel button

clearLabel

clearLabel: ClearLabel

Label to use for a clear button

closeLabel

closeLabel: CloseLabel

Label to use for a close button

customCancelLabel

customCancelLabel: string

Custom string label to use for a cancel button

customClearLabel

customClearLabel: string

Custom string label to use for a clear button

customCloseLabel

customCloseLabel: string

Custom string label to use for a close button

customFormProperties

customFormProperties: CustomFormProperties

If the FormMode is kcustom then use these properties

customNextLabel

customNextLabel: string

Custom string label to use for a next button

customPreviousLabel

customPreviousLabel: string

Custom string label to use for a previous button

customSubmitLabel

customSubmitLabel: string

Custom string label to use for a submit button

enterIsSubmit

enterIsSubmit: boolean

Whether the enter button should be replaced with a submit button

formMode

formMode: FormMode

The mode of the form buttons

keyboardMode

keyboardMode: KeyboardMode

keyboardZPosition

keyboardZPosition: KeyboardZPosition

Specifies the location to position the keyboard along the z axis

layoutType

layoutType: LayoutType

The layout type to use on the keyboard

nextLabel

nextLabel: NextLabel

Label to use for a next button

offsetPosition

offsetPosition: [number, number]

The offset in world coordinates to move the keyboard from its location

previousLabel

previousLabel: PreviousLabel

Label to use for a previous button

showAuxiliaryRow

showAuxiliaryRow: boolean

Whether the auxiliary is to be displayed

speechToTextEnabled

speechToTextEnabled: boolean

Whether the speech to text button should be enabled

submitLabel

submitLabel: SubmitLabel

Label to use for a submit button

suggestionMode

suggestionMode: SuggestionMode

Mode to use for suggestions

width

width: number

The width of the keyboard in world coordinates

widthRatio

widthRatio: number

The width of the keyboard as a ratio of the calling volume

Methods

equals

Generated using TypeDoc