HeldKeysController

Defined in: controllers/held-keys.ts:26

A Lit ReactiveController that tracks all currently held keyboard keys.

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

Example

class KeyDisplay extends LitElement {
  private heldKeys = new HeldKeysController(this)

  render() {
    return html`
      <div>
        Currently pressed: ${this.heldKeys.value.join(' + ') || 'None'}
      </div>
    `
  }
}

Implements

• ReactiveController

Constructors

Constructor

new HeldKeysController(_host): HeldKeysController;

Defined in: controllers/held-keys.ts:40

Parameters

_host

ReactiveControllerHost

The Lit component that owns this controller.

Returns

HeldKeysController

Accessors

value

Get Signature

get value(): string[];

Defined in: controllers/held-keys.ts:33

Array of currently held key names.

Returns

string[]

Methods

hostConnected()

hostConnected(): void;

Defined in: controllers/held-keys.ts:45

Subscribes to the tracker store and updates the internal state when changes occur.

Returns

void

Implementation of

ReactiveController.hostConnected

hostDisconnected()

hostDisconnected(): void;

Defined in: controllers/held-keys.ts:59

Unsubscribes from the tracker store and stops tracking the held keys.

Returns

void

Implementation of

ReactiveController.hostDisconnected