Skip to content

injectHeldKeys.md

Latest commit

 

History

History
34 lines (24 loc) · 714 Bytes

injectHeldKeys.md

File metadata and controls

34 lines (24 loc) · 714 Bytes
id injectHeldKeys
title injectHeldKeys

Function: injectHeldKeys()

function injectHeldKeys(): Signal<string[]>;

Defined in: injectHeldKeys.ts:23

Angular inject-based API that returns a signal of currently held keyboard keys.

Subscribes to the global KeyStateTracker and updates whenever keys are pressed or released.

Returns

Signal<string[]>

Signal of array of currently held key names

Example

@Component({
  template: `<div>Currently pressed: {{ heldKeys().join(' + ') || 'None' }}</div>`,
})
export class KeyDisplayComponent {
  heldKeys = injectHeldKeys()
}