Theia API Documentation v1.77.0
    Preparing search index...

    Representation of a pressed key combined with key modifiers.

    Index
    alt: boolean
    authoredToken: string | undefined
    character: string | undefined
    ctrl: boolean
    interpretation: KeyCodeInterpretation
    key: Key | undefined
    layoutModifiers: LayoutModifiers
    meta: boolean
    physical: boolean

    Whether the authored token denotes a physical scan code rather than a logical character.

    shift: boolean
    supportedByLayout: boolean

    Whether the authored logical character is available on the active keyboard layout.

    • Return the runtime match identity used for keybinding dispatch. The interpretation is diagnostic metadata and does not affect this identity.

      Returns string

    • Derive an authored keybinding stroke from a key event for recorder persistence. This cannot use toString: event-derived key codes have no authoredToken, so toString would persist the physical US key name instead of the committed logical character. Non-printable keys, Space and numpad keys are persisted by name; printable keys without a committed character are persisted as scan codes.

      Returns string