KeyboardProperties

lumin.ui. KeyboardProperties

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

Constructor

new KeyboardProperties()

Classes

CancelLabel
ClearLabel
CloseLabel
CustomFormProperties
FormMode
KeyboardMode
KeyboardZPosition
NextLabel
PreviousLabel
ShiftLabel
SubmitLabel
SuggestionMode

Members

cancelLabel :lumin.ui.KeyboardProperties.CancelLabel

Label to use for a cancel button

Type:

clearLabel :lumin.ui.KeyboardProperties.ClearLabel

Label to use for a clear button

Type:

closeLabel :lumin.ui.KeyboardProperties.CloseLabel

Label to use for a close button

Type:

customCancelLabel :string

Custom string label to use for a cancel button

Type:
  • string

customClearLabel :string

Custom string label to use for a clear button

Type:
  • string

customCloseLabel :string

Custom string label to use for a close button

Type:
  • string

customFormProperties :lumin.ui.KeyboardProperties.CustomFormProperties

If the FormMode is kcustom then use these properties

Type:

customNextLabel :string

Custom string label to use for a next button

Type:
  • string

customPreviousLabel :string

Custom string label to use for a previous button

Type:
  • string

customSubmitLabel :string

Custom string label to use for a submit button

Type:
  • string

enterIsSubmit :boolean

Whether the enter button should be replaced with a submit button

Type:
  • boolean

formMode :lumin.ui.KeyboardProperties.FormMode

The mode of the form buttons

Type:

keyboardMode :lumin.ui.KeyboardProperties.KeyboardMode

Type:

keyboardZPosition :lumin.ui.KeyboardProperties.KeyboardZPosition

Specifies the location to position the keyboard along the z axis

Type:

layoutType :lumin.ui.LayoutType

The layout type to use on the keyboard

Type:

nextLabel :lumin.ui.KeyboardProperties.NextLabel

Label to use for a next button

Type:

offsetPosition :vec2

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

Type:
  • vec2

previousLabel :lumin.ui.KeyboardProperties.PreviousLabel

Label to use for a previous button

Type:

showAuxiliaryRow :boolean

Whether the auxiliary is to be displayed

Type:
  • boolean

speechToTextEnabled :boolean

Whether the speech to text button should be enabled

Type:
  • boolean

submitLabel :lumin.ui.KeyboardProperties.SubmitLabel

Label to use for a submit button

Type:

suggestionMode :lumin.ui.KeyboardProperties.SuggestionMode

Mode to use for suggestions

Type:

width :number

The width of the keyboard in world coordinates

Type:
  • number

widthRatio :number

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

Type:
  • number

Methods

equals(other) → {boolean}

Parameters:
Name Type Description
other lumin.ui.KeyboardProperties
Returns:
Type
boolean