Skip to content

Interface: KeyboardPayload ​

Defined in: types/desktop-engine.d.ts:417

Keyboard event payload

Properties ​

altKey ​

ts
altKey: boolean;

Defined in: types/desktop-engine.d.ts:427

Whether Option is pressed


characters ​

ts
characters: string;

Defined in: types/desktop-engine.d.ts:421

The characters typed


code ​

ts
code: number;

Defined in: types/desktop-engine.d.ts:419

macOS virtual key code (NSEvent.keyCode)


ctrlKey ​

ts
ctrlKey: boolean;

Defined in: types/desktop-engine.d.ts:425

Whether Control is pressed


metaKey ​

ts
metaKey: boolean;

Defined in: types/desktop-engine.d.ts:429

Whether Command is pressed


repeat ​

ts
repeat: boolean;

Defined in: types/desktop-engine.d.ts:423

Whether this is a key repeat from holding the key down


shiftKey ​

ts
shiftKey: boolean;

Defined in: types/desktop-engine.d.ts:431

Whether Shift is pressed

The SDK is released under the Apache License 2.0