Interface KeyboardEventContext

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

Properties

key event isShift isControl isAlt hasModifier modifiers up repeat action

Properties

key

key: string

The normalized string key, such as "A"

event

event: KeyboardEvent

The originating keypress event

isShift

isShift: boolean

Is the Shift modifier being pressed

isControl

isControl: boolean

Is the Control or Meta modifier being processed

isAlt

isAlt: boolean

Is the Alt modifier being pressed

hasModifier

hasModifier: boolean

Are any of the modifiers being pressed

modifiers

modifiers: string[]

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

up

up: boolean

True if the Key is Up, else False if down

repeat

repeat: boolean

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

action

action: string

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

Settings

Member Visibility

Theme

On This Page

keyeventisShiftisControlisAlthasModifiermodifiersuprepeataction