Class VirtualKeyboard

Hierarchy

Properties

boundingRect: DOMRect

Indicates the position and size of the on-screen virtual keyboard that overlays the screen.

enableDictionary?: boolean

If set to true, then the dictionary will be enabled for faster user input based on predictive text.

enableReturn?: boolean

If set to true, then the "Return" key will be enabled, allowing for newlines to be included in the input.

leftButtonText?: string

Single character to use for the left-side button.

Example

"-"

Note

Only for "NumPad" keyboard type.

maxLength?: number

Specifies the max string length. When the input is too long, input will stop being accepted.

minLength?: number

Specifies the min string length. When the input is too short, the "OK" button will be disabled.

okButtonText?: string

Text to display for the "OK" button. Max of 8 characters.

Example

"Submit"
rightButtonText?: string

Single character to use for the right-side button.

Example

"+"

Note

Only for "NumPad" keyboard type.

type?: number

Set the type of virtual keyboard.

Accessors

  • get cursorIndex(): number
  • Returns number

  • get overlaysContent(): boolean
  • Returns boolean

  • get value(): string
  • Returns string

Methods

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    Returns void

Generated using TypeDoc