Skip to main content

Interface: VirtualKeyboardEvent

Extends​

  • CompositeEvent

Properties​

code​

code: string

Code for the key, not taking into account any modifiers.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:114

compositeEventType​

compositeEventType: "VirtualKeyboardKeyUp" | "VirtualKeyboardKeyDown" | "VirtualKeyboardKeyLeave"

The type of the composite event.

Overrides​

CompositeEvent.compositeEventType

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:106

compositeType​

compositeType: "VirtualKeyboard"

The type of the composite node.

Overrides​

CompositeEvent.compositeType

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:105

handled?​

optional handled: boolean

Has the event been taken care of by the listener and not be dispatched to other targets?

Inherited from​

CompositeEvent.handled

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:2854

iso8601Timestamp​

iso8601Timestamp: string

Timestamp of th event, from new Date().toISOString()

Inherited from​

CompositeEvent.iso8601Timestamp

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:2858

key​

key: string

String that is generated when key is pressed, with any modifiers (e.g., Shift) applied.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:112

keyTapMetadata​

keyTapMetadata: KeyTapMetadata

Metadata related to the key tap.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:118

sequence?​

optional sequence: number

Sequence number of event.

Remarks​

Sequence number is guaranteed to reflect order of events, but not necessarily contiguous, e.g., could be 1, 2, 5, 10, 11, 24.

Inherited from​

CompositeEvent.sequence

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:2863

shiftKey​

shiftKey: boolean

True if the Shift key is pressed.

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:116

target​

target: string | VirtualKeyboard

The Composite on which the event occurred. If the event has gone through serialization, the string will be the composite's UUID.

Overrides​

CompositeEvent.target

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:110

timestamp​

timestamp: number

Timestamp of the event, from performance.now()

Inherited from​

CompositeEvent.timestamp

Defined in​

node_modules/@m2c2kit/core/dist/index.d.ts:2856

type​

type: "Composite"

Overrides​

CompositeEvent.type

Defined in​

m2c2kit/packages/addons/src/composites/virtual-keyboard.ts:104