Class KeyCode

Representation of a pressed key combined with key modifiers.

Hierarchy

KeyCode

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KeyCode(schema: KeyCodeSchema): KeyCode

- Defined in packages/core/src/common/keys.ts:120
Parameters
- schema: KeyCodeSchema
Returns KeyCode

Properties

Readonly alt

alt: boolean

Readonly character

character: undefined | string

Readonly ctrl

ctrl: boolean

Readonly key

key: undefined | Key

Readonly meta

meta: boolean

Readonly shift

shift: boolean

Static Private keybindings

keybindings: {} = {}

Type declaration

[key: string]: KeyCode

Methods

equals

equals(other: KeyCode): boolean

- Defined in packages/core/src/common/keys.ts:148
Return true if the given KeyCode is equal to this one.

Parameters
- other: KeyCode
Returns boolean

isModifierOnly

isModifierOnly(): boolean

- Defined in packages/core/src/common/keys.ts:141
Return true if this KeyCode only contains modifiers.

Returns boolean

toString

toString(): string

- Defined in packages/core/src/common/keys.ts:158
Returns string

Static createKeyCode

createKeyCode(input: string | KeyboardEvent | Keystroke | KeyCodeSchema, eventDispatch?: "code" | "keyCode"): KeyCode

- Defined in packages/core/src/common/keys.ts:181
Create a KeyCode from one of several input types.

Parameters
- input: string | KeyboardEvent | Keystroke | KeyCodeSchema
- eventDispatch: "code" | "keyCode" = 'code'
Returns KeyCode

Static parse

parse(keybinding: string): KeyCode

- Defined in packages/core/src/common/keys.ts:234
Parses a string and returns a KeyCode object.

Parameters
- keybinding: string
  
  String representation of a keybinding
Returns KeyCode

Static resetKeyBindings

resetKeyBindings(): void

- Defined in packages/core/src/common/keys.ts:226
Returns void