HotkeyScopesStateController

Defined in: controllers/hotkey-scopes-state.ts:22

A Lit ReactiveController that reads the hotkey manager's scope state: the active scopes, the exclusive scope that owns the keyboard, and the scopes it allows or suspends. Triggers host updates when scopes activate or release.

Example

class KeyboardOwner extends LitElement {
  private scopes = new HotkeyScopesStateController(this)

  render() {
    const { exclusive } = this.scopes.value
    return exclusive ? html`<p>Shortcuts belong to ${exclusive}</p>` : nothing
  }
}

Implements

ReactiveController

Constructors

Constructor

new HotkeyScopesStateController(_host): HotkeyScopesStateController;

Defined in: controllers/hotkey-scopes-state.ts:34

Parameters

_host

ReactiveControllerHost

The Lit component that owns this controller.

Returns

HotkeyScopesStateController

Accessors

value

Get Signature

get value(): HotkeyScopesState;

Defined in: controllers/hotkey-scopes-state.ts:27

The current scope state.

Returns

HotkeyScopesState

Methods

hostConnected()

hostConnected(): void;

Defined in: controllers/hotkey-scopes-state.ts:43

Subscribes to the scopes store and updates the host when it changes. Connecting requests an update too, since scopes may have changed while disconnected.