VirtualKeyboard
See
https://developer.mozilla.org/docs/Web/API/VirtualKeyboard
Extends
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
boundingRect | readonly | DOMRect | Indicates the position and size of the on-screen virtual keyboard that overlays the screen. See https://developer.mozilla.org/docs/Web/API/VirtualKeyboard/boundingRect |
enableDictionary? | public | boolean | If set to true, then the dictionary will be enabled for faster user input based on predictive text. |
enableReturn? | public | boolean | If set to true, then the "Return" key will be enabled, allowing for newlines to be included in the input. |
leftButtonText? | public | string | Single character to use for the left-side button. Example "-" Note Only for "NumPad" keyboard type. |
maxLength? | public | number | Specifies the max string length. When the input is too long, input will stop being accepted. |
minLength? | public | number | Specifies the min string length. When the input is too short, the "OK" button will be disabled. |
okButtonText? | public | string | Text to display for the "OK" button. Max of 8 characters. Example "Submit" |
rightButtonText? | public | string | Single character to use for the right-side button. Example "+" Note Only for "NumPad" keyboard type. |
type? | public | number | Set the type of virtual keyboard. |
Accessors
cursorIndex
get cursorIndex(): number
set cursorIndex(i): void
Parameters
| Parameter | Type |
|---|---|
i | number |
Returns
number
overlaysContent
get overlaysContent(): boolean
Returns
boolean
value
get value(): string
set value(v): void
Parameters
| Parameter | Type |
|---|---|
v | string |
Returns
string
Methods
addEventListener()
addEventListener(type, callback, options?): void
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
| Parameter | Type |
|---|---|
type | string |
callback | null | EventListenerOrEventListenerObject<any> |
options? | boolean | AddEventListenerOptions |
Returns
void
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/addEventListener
dispatchEvent()
dispatchEvent(event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
See
https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent
hide()
hide(): void
Hides the on-screen virtual keyboard.
Returns
void
undefined and triggers a "geometrychange" event.
See
https://developer.mozilla.org/docs/Web/API/VirtualKeyboard/hide
removeEventListener()
removeEventListener(type, callback, options?): void
Removes the event listener in target's event listener list with the same type, callback, and options.
Parameters
| Parameter | Type |
|---|---|
type | string |
callback | null | EventListenerOrEventListenerObject<any> |
options? | boolean | EventListenerOptions |
Returns
void
Inherited from
EventTarget.removeEventListener
See
https://developer.mozilla.org/docs/Web/API/EventTarget/removeEventListener
show()
show(): void
Shows the on-screen virtual keyboard.
Returns
void
undefined and triggers a "geometrychange" event.
See
https://developer.mozilla.org/docs/Web/API/VirtualKeyboard/show