Contains the settings for the virtual keyboard.
Path:

ui.virtualKeyboard

Hierarchy

  • VirtualKeyboardConfig

Properties

autoCollapse: boolean

Default: true

True when the keyboard should automatically collapse when no element is selected that allows keyboard input.

ui.virtualKeyboard.autoCollapse

autoCollapseTimeoutInSeconds: number

Default: 0

Time in seconds after which the keyboard will collapse.

ui.virtualKeyboard.autoCollapseTimeoutInSeconds

autoExpand: boolean

Default: true

True when the keyboard is allowed to expand automatically when an element is selected which allowes keyboard input.

ui.virtualKeyboard.autoExpand

autoExpandTimeoutInSeconds: number

Default: 0

Time in seconds after which the keyboard will expand.

ui.virtualKeyboard.autoExpandTimeoutInSeconds

enabled: boolean

Default: false

True when the virtual keyboard should be active.

ui.virtualKeyboard.enabled

floatingDefaultPosition: VirtualKeyboardFloatingPosition

Default: "BottomCenter"

The default position of the floating keyboard.

ui.virtualKeyboard.floatingDefaultPosition

floatingOffset: Unit2D

The offset to the default position of the floating keyboard.

ui.virtualKeyboard.floatingOffset

hideWhenCollapsed: boolean

Default: true

True when the keyboard will hide completely when it should collapse.

ui.virtualKeyboard.hideWhenCollapsed

hideWhenUserIsIdle: boolean

Default: true

True when the virtual keyboard should be hidden when the user is idle.

ui.virtualKeyboard.hideWhenUserIsIdle

layout: string

Default: "simplified"

Name of the keyboard layout.

ui.virtualKeyboard.layout

Default: "Floating"

The dock mode.

ui.virtualKeyboard.mode

playSounds: boolean

Default: true

True when the keyboard should play sounds when the user uses the keyboard.

ui.virtualKeyboard.playSounds

showKeyboardLanguageChanger: boolean

Default: true

True when a language chooser should be visible inside of the keyboard.

ui.virtualKeyboard.showKeyboardLanguageChanger

Generated using TypeDoc