bndr-js - v1.0.0 / Keyboard

Namespace: Keyboard

Interfaces

Functions

all

all(): Observable<KeyEvent>

Raw key event stream. Useful for advanced cases.

Returns

Observable<KeyEvent>

Defined in

keyboard.ts:382open in new window


keydown

keydown(key, opts?): GlyphedObservable<void>

Bangs on each keydown of key.

Parameters

NameType
keystring
opts?Options

Returns

GlyphedObservable<void>

Defined in

keyboard.ts:334open in new window


keyup

keyup(key, opts?): GlyphedObservable<void>

Bangs on each keyup of key.

Parameters

NameType
keystring
opts?Options

Returns

GlyphedObservable<void>

Defined in

keyboard.ts:347open in new window


pressed

pressed(key, opts?): GlyphedObservable<boolean>

Emits true while key is held, false otherwise.

Parameters

NameType
keystring
opts?Options

Returns

GlyphedObservable<boolean>

Defined in

keyboard.ts:316open in new window


shortcut

shortcut(combo, opts?): GlyphedObservable<void>

Bangs when combo (e.g. 'cmd+s') is pressed.

Parameters

NameType
combostring
opts?HotkeyOptions

Returns

GlyphedObservable<void>

Defined in

keyboard.ts:360open in new window