Interface KeyPressEvent

Represents a keydown or auto-repeated keydown event.

Use keyPressEventFromHTMLEvent where possible rather than constructing directly (required properties may change between minor releases).

interface KeyPressEvent {
    altKey: undefined | boolean;
    code: string;
    ctrlKey: undefined | boolean;
    key: string;
    kind: KeyPressEvent;
    shiftKey: undefined | boolean;
}

Hierarchy

  • BaseKeyEvent
    • KeyPressEvent

Properties

altKey code ctrlKey key kind shiftKey

Properties

Readonly altKey

altKey: undefined | boolean

If falsey, the alt key is not pressed.

Readonly code

code: string

Readonly ctrlKey

ctrlKey: undefined | boolean

If ctrlKey is undefined, that is equivalent to ctrlKey = false.

Readonly key

key: string

key, as given by an HTML KeyboardEvent

Readonly kind

kind: KeyPressEvent

Readonly shiftKey

shiftKey: undefined | boolean

If falsey, the shift key is not pressed.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

OpenSource licenses