Interface KeyboardEventContext

A keyboard event context

interface KeyboardEventContext {
    action?: string;
    event: KeyboardEvent;
    hasModifier: boolean;
    isAlt: boolean;
    isControl: boolean;
    isShift: boolean;
    key: string;
    logicalKey: string;
    modifiers: string[];
    repeat: boolean;
    up: boolean;
}

Properties

action? event hasModifier isAlt isControl isShift key logicalKey modifiers repeat up

Properties

Optionalaction

action?: string

The executing Keybinding Action. May be undefined until the action is known.

event

event: KeyboardEvent

The originating keypress event

hasModifier

hasModifier: boolean

Are any of the modifiers being pressed

isAlt

isAlt: boolean

Is the Alt modifier being pressed

isControl

isControl: boolean

Is the Control or Meta modifier being processed

isShift

isShift: boolean

Is the Shift modifier being pressed

key

key: string

The normalized string key, such as "KeyA"

logicalKey

logicalKey: string

The logical string key, such as "a"

modifiers

modifiers: string[]

A list of string modifiers applied to this context, such as ["CONTROL"]

repeat

repeat: boolean

True if the given key is being held down such that it is automatically repeating.

up

up: boolean

True if the Key is Up, else False if down

Settings

Member Visibility

On This Page

Properties