igniteui-webcomponents 7.2.4 → 7.3.0-beta.1

package/{components/common → internals}/controllers/gestures.js

@@ -62,6 +62,9 @@ class GesturesController extends EventTarget {
     hostConnected() {
         const { signal } = this._abortHandle;
         this._host.updateComplete.then(() => {
+            if (signal.aborted || !this._element) {
+                return;
+            }
             for (const event of Events) {
                 this._element.addEventListener(event, this, { passive: true, signal });
             }
@@ -77,9 +80,7 @@ class GesturesController extends EventTarget {
         return { x, y, time: Date.now() };
     }
     _setTouchActionState(disabled) {
-        Object.assign(this._element.style, {
-            touchAction: disabled ? 'none' : undefined,
-        });
+        this._element.style.touchAction = disabled ? 'none' : '';
     }
     _resetState() {
         this._pointerState.start = defaultState;
@@ -92,8 +93,10 @@ class GesturesController extends EventTarget {
             : this._element.releasePointerCapture(event.pointerId);
     }
     _handlePointerDown(event) {
+        const state = this._getGestureState(event);
         this._setTouchActionState(true);
-        this._pointerState.start = this._getGestureState(event);
+        this._pointerState.start = state;
+        this._pointerState.current = state;
         this._setPointerCaptureState(event, true);
     }
     _handlePointerMove(event) {

package/internals/controllers/gestures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gestures.js","sourceRoot":"","sources":["../../../src/internals/controllers/gestures.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,MAAM,GAAG;IACb,aAAa;IACb,aAAa;IACb,oBAAoB;IACpB,eAAe;CACP,CAAC;AACX,MAAM,YAAY,GAAiB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;AAoD1E,MAAM,OAAO,UAAW,SAAQ,KAAK;IAInC,YAAY,IAAY,EAAE,IAAiB,EAAE,WAAuB;QAClE,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAED,MAAM,kBAAmB,SAAQ,WAAW;IAiB1C,IAAc,QAAQ;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IACnD,CAAC;IAGD,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,YACE,IAA0C,EAC1C,OAAyB;QAEzB,KAAK,EAAE,CAAC;QA3BO,iBAAY,GAAG,iBAAiB,EAAE,CAAC;QAE5C,aAAQ,GAAoB;YAClC,iBAAiB,EAAE,GAAG;YACtB,aAAa,EAAE,GAAG;YAClB,SAAS,EAAE,KAAK;SACjB,CAAC;QAEM,kBAAa,GAAG;YACtB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,YAAY;SACtB,CAAC;QAiBA,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAE9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAKM,GAAG,CACR,IAAiB,EACjB,QAAqC,EACrC,OAAiC;QAEjC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAkB,CAAC;QAEzD,IAAI,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IACd,CAAC;IAGM,WAAW,CAAC,KAAmB;QACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,IAAI,KAAK,CAAC,WAAW,KAAK,OAAO,EAAE,CAAC;YAC7D,OAAO;QACT,CAAC;QAED,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,aAAa;gBAChB,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,aAAa;gBAChB,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;gBAC/B,MAAM;YACR,KAAK,oBAAoB,CAAC;YAC1B,KAAK,eAAe;gBAClB,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAGM,aAAa;QAClB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC;QAErC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE;YAClC,IAAI,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACrC,OAAO;YACT,CAAC;YAED,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBAC3B,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;YACzE,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAGM,gBAAgB;QACrB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAGM,aAAa,CAAC,OAAqC;QACxD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxC,CAAC;IAEO,gBAAgB,CAAC,EACvB,OAAO,EAAE,CAAC,EACV,OAAO,EAAE,CAAC,GACG;QACb,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;IACpC,CAAC;IAEO,oBAAoB,CAAC,QAAiB;QAC5C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAC3D,CAAC;IAEO,WAAW;QACjB,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,YAAY,CAAC;QACxC,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,YAAY,CAAC;IAC5C,CAAC;IAEO,uBAAuB,CAAC,KAAmB,EAAE,KAAc;QACjE,IAAI,CAAC,aAAa,CAAC,QAAQ,GAAG,KAAK,CAAC;QACpC,KAAK;YACH,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,KAAK,CAAC,SAAS,CAAC;YAClD,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAC3D,CAAC;IAEO,kBAAkB,CAAC,KAAmB;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAGhC,IAAI,CAAC,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QACjC,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,KAAK,CAAC;QACnC,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEO,kBAAkB,CAAC,KAAmB;QAC5C,IAAI,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,aAAa,CAAC,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,IAAiB,EAAE,IAAiB;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,gBAAgB;QACtB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAE9C,OAAO;YACL,MAAM,EAAE,KAAK,CAAC,CAAC;YACf,IAAI,EAAE,OAAO,CAAC,CAAC;YACf,MAAM,EAAE,KAAK,CAAC,CAAC;YACf,IAAI,EAAE,OAAO,CAAC,CAAC;SAChB,CAAC;IACJ,CAAC;IAES,UAAU;QAClB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC;QAE9C,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QACrC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;QAC/B,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;QAE/B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,IAAI,GAAG,CAAC;QAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,IAAI,GAAG,CAAC;QAExD,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;YACd,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC;YAC7C,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC;YAC9C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC;YAC7C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,EAAE,GAAG,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,yBAAyB,CAAC,KAAmB;QACnD,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAEhC,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,IAAI,GAAgB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE;gBAC/D,IAAI,EAAE,KAAK,CAAC,WAAW;gBACvB,SAAS,EAAE,KAAK;aACjB,CAAC,CAAC;YAEH,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,SAAS,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAMD,MAAM,UAAU,qBAAqB,CACnC,IAA0C,EAC1C,OAAyB;IAEzB,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AAC/C,CAAC","sourcesContent":["import type { ReactiveController, ReactiveControllerHost } from 'lit';\nimport type { Ref } from 'lit/directives/ref.js';\nimport { createAbortHandle } from '../abort-handler.js';\n\nconst Events = [\n  'pointerdown',\n  'pointermove',\n  'lostpointercapture',\n  'pointercancel',\n] as const;\nconst defaultState: GestureState = Object.freeze({ x: 0, y: 0, time: 0 });\n\n/**\n * Configuration object for a {@link GesturesController} instance.\n * @hidden\n */\nexport interface GesturesOptions {\n  /**\n   * By default, the controller listens for pointer/touch events in the context of the host element.\n   * If you pass a `ref`, you can limit the observation to a certain DOM part of the host scope.\n   */\n  ref?: Ref<HTMLElement>;\n  /**\n   * The maximum amount of milliseconds between the start and end of a gesture combination\n   * before it is recognized as such.\n   */\n  thresholdTime?: number;\n  /**\n   * The minimum amount a \"pointer\" should travel in pixels, before being recognized as a\n   * gesture.\n   */\n  thresholdDistance?: number;\n  /**\n   * When enabled, the controller will skip events generated by a mouse device.\n   */\n  touchOnly?: boolean;\n}\n\ntype GestureState = {\n  x: number;\n  y: number;\n  time: number;\n};\n\ntype GestureDirection = 'left' | 'up' | 'right' | 'down';\ntype SwipeEvents =\n  | 'swipe'\n  | 'swipe-left'\n  | 'swipe-up'\n  | 'swipe-right'\n  | 'swipe-down';\n\nexport type GestureData = {\n  direction: GestureDirection;\n  type: string;\n  xStart: number;\n  xEnd: number;\n  yStart: number;\n  yEnd: number;\n};\n\n/* blazorSuppress */\nexport class SwipeEvent extends Event {\n  public readonly data: GestureData;\n  public readonly name: string;\n\n  constructor(name: string, data: GestureData, initOptions?: EventInit) {\n    super(name, initOptions);\n    this.name = name;\n    this.data = data;\n  }\n}\n\nclass GesturesController extends EventTarget implements ReactiveController {\n  private readonly _host: ReactiveControllerHost & HTMLElement;\n  private readonly _ref?: Ref<HTMLElement>;\n  private readonly _abortHandle = createAbortHandle();\n\n  private _options: GesturesOptions = {\n    thresholdDistance: 100,\n    thresholdTime: 500,\n    touchOnly: false,\n  };\n\n  private _pointerState = {\n    captured: false,\n    start: defaultState,\n    current: defaultState,\n  };\n\n  protected get _element() {\n    return this._ref ? this._ref.value! : this._host;\n  }\n\n  /** Get the current configuration object */\n  public get options(): GesturesOptions {\n    return this._options;\n  }\n\n  constructor(\n    host: ReactiveControllerHost & HTMLElement,\n    options?: GesturesOptions\n  ) {\n    super();\n\n    Object.assign(this._options, options);\n    this._ref = this._options.ref;\n\n    this._host = host;\n    this._host.addController(this);\n  }\n\n  /**\n   * Add an event listener for a given swipe event.\n   */\n  public set(\n    type: SwipeEvents,\n    callback: (event: SwipeEvent) => void,\n    options?: AddEventListenerOptions\n  ): this {\n    const bound = callback.bind(this._host) as EventListener;\n\n    this.addEventListener(type, bound, options);\n    return this;\n  }\n\n  /** @internal */\n  public handleEvent(event: PointerEvent): void {\n    if (this._options.touchOnly && event.pointerType === 'mouse') {\n      return;\n    }\n\n    switch (event.type) {\n      case 'pointerdown':\n        this._handlePointerDown(event);\n        break;\n      case 'pointermove':\n        this._handlePointerMove(event);\n        break;\n      case 'lostpointercapture':\n      case 'pointercancel':\n        this._handleLostPointerCapture(event);\n    }\n  }\n\n  /** @internal */\n  public hostConnected(): void {\n    const { signal } = this._abortHandle;\n\n    this._host.updateComplete.then(() => {\n      if (signal.aborted || !this._element) {\n        return;\n      }\n\n      for (const event of Events) {\n        this._element.addEventListener(event, this, { passive: true, signal });\n      }\n    });\n  }\n\n  /** @internal */\n  public hostDisconnected(): void {\n    this._abortHandle.abort();\n  }\n\n  /** Updates the configuration of the controller */\n  public updateOptions(options: Omit<GesturesOptions, 'ref'>): void {\n    Object.assign(this._options, options);\n  }\n\n  private _getGestureState({\n    clientX: x,\n    clientY: y,\n  }: PointerEvent): GestureState {\n    return { x, y, time: Date.now() };\n  }\n\n  private _setTouchActionState(disabled: boolean) {\n    this._element.style.touchAction = disabled ? 'none' : '';\n  }\n\n  private _resetState() {\n    this._pointerState.start = defaultState;\n    this._pointerState.current = defaultState;\n  }\n\n  private _setPointerCaptureState(event: PointerEvent, state: boolean) {\n    this._pointerState.captured = state;\n    state\n      ? this._element.setPointerCapture(event.pointerId)\n      : this._element.releasePointerCapture(event.pointerId);\n  }\n\n  private _handlePointerDown(event: PointerEvent) {\n    const state = this._getGestureState(event);\n\n    this._setTouchActionState(true);\n    // Seeded so that a press without any movement resolves to a zero delta\n    // instead of being measured against the zeroed default state.\n    this._pointerState.start = state;\n    this._pointerState.current = state;\n    this._setPointerCaptureState(event, true);\n  }\n\n  private _handlePointerMove(event: PointerEvent) {\n    if (this._pointerState.captured) {\n      this._pointerState.current = this._getGestureState(event);\n    }\n  }\n\n  private _emit(name: SwipeEvents, data: GestureData) {\n    return this.dispatchEvent(new SwipeEvent(name, data));\n  }\n\n  private _createEventArgs() {\n    const { start, current } = this._pointerState;\n\n    return {\n      xStart: start.x,\n      xEnd: current.x,\n      yStart: start.y,\n      yEnd: current.y,\n    };\n  }\n\n  protected _recognize(): GestureDirection | false {\n    const { start, current } = this._pointerState;\n\n    const dt = current.time - start.time;\n    const dx = current.x - start.x;\n    const dy = current.y - start.y;\n\n    const time = this._options.thresholdTime ?? 500;\n    const distance = this._options.thresholdDistance ?? 100;\n\n    if (dt > time) {\n      return false;\n    }\n\n    if (dx > distance && Math.abs(dy) < distance) {\n      return 'right';\n    }\n\n    if (-dx > distance && Math.abs(dy) < distance) {\n      return 'left';\n    }\n\n    if (dy > distance && Math.abs(dx) < distance) {\n      return 'down';\n    }\n\n    if (-dy > distance && Math.abs(dx) < distance) {\n      return 'up';\n    }\n\n    return false;\n  }\n\n  private _handleLostPointerCapture(event: PointerEvent) {\n    this._setPointerCaptureState(event, false);\n    const state = this._recognize();\n\n    if (state) {\n      const args: GestureData = Object.assign(this._createEventArgs(), {\n        type: event.pointerType,\n        direction: state,\n      });\n\n      this._emit('swipe', args);\n      this._emit(`swipe-${state}`, args);\n    }\n\n    this._resetState();\n    this._setTouchActionState(false);\n  }\n}\n\n/**\n * Adds a {@link GesturesController} responsible for managing gesture behaviors\n * for the given host element.\n */\nexport function addGesturesController(\n  host: ReactiveControllerHost & HTMLElement,\n  options?: GesturesOptions\n) {\n  return new GesturesController(host, options);\n}\n"]}

package/internals/controllers/group.d.ts

@@ -0,0 +1,64 @@
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+type GroupHost = ReactiveControllerHost & Element;
+/** The object a group's identity is bound to - a root node, a container element. */
+type GroupScope = object;
+type GroupRegistryConfig<T extends GroupHost, S> = {
+    /**
+     * The group key of a host. Together with the scope it forms the identity of
+     * a group. A host with an empty key stays on its own.
+     */
+    keyOf: (host: T) => string;
+    /**
+     * Derives the group-wide state that each member receives on sync, from the
+     * current members of the group.
+     */
+    deriveState: (members: T[]) => S;
+    /**
+     * The scope the group identity is bound to. Defaults to the host's root
+     * node (document or shadow root).
+     */
+    scopeOf?: (host: T) => GroupScope;
+};
+/** The membership of one host, attached to it as a reactive controller. */
+interface GroupMemberController<T extends GroupHost> extends ReactiveController {
+    /** The hosts of this member's group, in DOM order. A host with no group is on its own. */
+    readonly members: T[];
+    /**
+     * Moves the host to the group of its current scope and key. Does nothing
+     * while both stay the same. If not, the group that the host joins and the
+     * group that it leaves both update their state.
+     */
+    updateMembership(): void;
+    /** Updates the state of the host group. */
+    sync(): void;
+}
+interface GroupRegistry<T extends GroupHost, S> {
+    /** Creates and attaches a membership controller to the host. */
+    attach(host: T, onSync: (state: S) => void): GroupMemberController<T>;
+    /** Returns the hosts of the group of `member`, in DOM order. */
+    membersOf(member: T): T[];
+}
+/**
+ * Creates a registry of groups whose members discover each other through a
+ * shared scope and key instead of a common parent element - the way native
+ * radio buttons group by their `name` within a form root.
+ *
+ * Each member holds its own entry for its life-cycle, so that a group read
+ * reflects the actual membership and the members that stay behind derive their
+ * state again when one leaves - a change a member cannot see on its own.
+ *
+ * One registry holds one kind of group; create it at module level:
+ *
+ * @example
+ * ```typescript
+ * const radioGroups = createGroupRegistry<IgcRadioComponent, boolean>({
+ *   keyOf: (radio) => radio.name || '',
+ *   deriveState: (radios) => radios.some((radio) => radio.checked),
+ * });
+ *
+ * // In the component:
+ * private readonly _group = radioGroups.attach(this, (state) => { ... });
+ * ```
+ */
+export declare function createGroupRegistry<T extends GroupHost, S>(config: GroupRegistryConfig<T, S>): GroupRegistry<T, S>;
+export type { GroupMemberController, GroupRegistry, GroupRegistryConfig };

package/internals/controllers/group.js

@@ -0,0 +1,104 @@
+import { isEmpty } from '../utils/arrays.js';
+import { getRoot } from '../utils/dom.js';
+function byDocumentOrder(a, b) {
+    if (a === b) {
+        return 0;
+    }
+    return a.compareDocumentPosition(b) & Node.DOCUMENT_POSITION_FOLLOWING
+        ? -1
+        : 1;
+}
+export function createGroupRegistry(config) {
+    const groups = new WeakMap();
+    const controllers = new WeakMap();
+    function scopeOf(host) {
+        return config.scopeOf?.(host) ?? getRoot(host);
+    }
+    function syncGroup(group) {
+        const members = Array.from(group);
+        const state = config.deriveState(members.map((member) => member.host));
+        for (const member of members) {
+            member.onSync(state);
+        }
+    }
+    class Member {
+        get _isCurrent() {
+            return (config.keyOf(this.host) === this._key &&
+                scopeOf(this.host) === this._scope);
+        }
+        get _group() {
+            const entries = this._scope
+                ? Array.from(groups.get(this._scope)?.get(this._key) ?? [])
+                : [];
+            const members = entries.filter((member) => member._isCurrent);
+            return isEmpty(members)
+                ? [this]
+                : members.sort((a, b) => byDocumentOrder(a.host, b.host));
+        }
+        get members() {
+            return this._group.map((member) => member.host);
+        }
+        constructor(host, onSync) {
+            this._scope = null;
+            this._key = '';
+            this.host = host;
+            this.onSync = onSync;
+            controllers.set(host, this);
+            host.addController(this);
+        }
+        hostConnected() {
+            this.updateMembership();
+        }
+        hostDisconnected() {
+            this._unregister();
+        }
+        updateMembership() {
+            const scope = this.host.isConnected ? scopeOf(this.host) : null;
+            const key = config.keyOf(this.host);
+            if (scope === this._scope && key === this._key) {
+                return;
+            }
+            this._unregister();
+            if (scope && key) {
+                this._scope = scope;
+                this._key = key;
+                const keys = groups.get(scope) ?? new Map();
+                const group = keys.get(key) ?? new Set();
+                keys.set(key, group);
+                groups.set(scope, keys);
+                group.add(this);
+            }
+            this.sync();
+        }
+        sync() {
+            syncGroup(this._group);
+        }
+        _unregister() {
+            const { _scope: scope, _key: key } = this;
+            const keys = scope ? groups.get(scope) : undefined;
+            const group = keys?.get(key);
+            this._scope = null;
+            this._key = '';
+            if (!group?.delete(this)) {
+                return;
+            }
+            if (isEmpty(group)) {
+                keys?.delete(key);
+            }
+            else {
+                syncGroup(group);
+            }
+        }
+    }
+    return {
+        attach(host, onSync) {
+            return new Member(host, onSync);
+        },
+        membersOf(member) {
+            const controller = controllers.get(member);
+            controller?.updateMembership();
+            return controller?.members ?? [member];
+        },
+    };
+}
+//# sourceMappingURL=group.js.map

package/internals/controllers/group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"group.js","sourceRoot":"","sources":["../../../src/internals/controllers/group.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAgD1C,SAAS,eAAe,CAAC,CAAO,EAAE,CAAO;IACvC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,2BAA2B;QACpE,CAAC,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC,CAAC;AACR,CAAC;AAwBD,MAAM,UAAU,mBAAmB,CACjC,MAAiC;IAEjC,MAAM,MAAM,GAAG,IAAI,OAAO,EAAwC,CAAC;IACnE,MAAM,WAAW,GAAG,IAAI,OAAO,EAAa,CAAC;IAE7C,SAAS,OAAO,CAAC,IAAO;QACtB,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAGD,SAAS,SAAS,CAAC,KAAuB;QACxC,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAEvE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAED,MAAM,MAAM;QASV,IAAY,UAAU;YACpB,OAAO,CACL,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI;gBACrC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,CACnC,CAAC;QACJ,CAAC;QAED,IAAY,MAAM;YAChB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM;gBACzB,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC3D,CAAC,CAAC,EAAE,CAAC;YAIP,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAE9D,OAAO,OAAO,CAAC,OAAO,CAAC;gBACrB,CAAC,CAAC,CAAC,IAAI,CAAC;gBACR,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAW,OAAO;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,CAAC;QAED,YAAY,IAAO,EAAE,MAA0B;YA7BvC,WAAM,GAAsB,IAAI,CAAC;YACjC,SAAI,GAAG,EAAE,CAAC;YA6BhB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YAErB,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;QAEM,aAAa;YAClB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC1B,CAAC;QAEM,gBAAgB;YACrB,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,CAAC;QAEM,gBAAgB;YACrB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAChE,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEpC,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC/C,OAAO;YACT,CAAC;YAED,IAAI,CAAC,WAAW,EAAE,CAAC;YAEnB,IAAI,KAAK,IAAI,GAAG,EAAE,CAAC;gBACjB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gBACpB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;gBAEhB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,GAAG,EAAuB,CAAC;gBACjE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,EAAU,CAAC;gBAEjD,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACxB,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC;YAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;QAEM,IAAI;YACT,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAEO,WAAW;YACjB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;YAC1C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACnD,MAAM,KAAK,GAAG,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YAE7B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;YACnB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;YAEf,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;iBAAM,CAAC;gBAGN,SAAS,CAAC,KAAK,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;KACF;IAED,OAAO;QACL,MAAM,CAAC,IAAI,EAAE,MAAM;YACjB,OAAO,IAAI,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClC,CAAC;QAED,SAAS,CAAC,MAAM;YACd,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAI3C,UAAU,EAAE,gBAAgB,EAAE,CAAC;YAE/B,OAAO,UAAU,EAAE,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC;KACF,CAAC;AACJ,CAAC","sourcesContent":["import type { ReactiveController, ReactiveControllerHost } from 'lit';\nimport { isEmpty } from '../utils/arrays.js';\nimport { getRoot } from '../utils/dom.js';\n\ntype GroupHost = ReactiveControllerHost & Element;\n\n/** The object a group's identity is bound to - a root node, a container element. */\ntype GroupScope = object;\n\ntype GroupRegistryConfig<T extends GroupHost, S> = {\n  /**\n   * The group key of a host. Together with the scope it forms the identity of\n   * a group. A host with an empty key stays on its own.\n   */\n  keyOf: (host: T) => string;\n  /**\n   * Derives the group-wide state that each member receives on sync, from the\n   * current members of the group.\n   */\n  deriveState: (members: T[]) => S;\n  /**\n   * The scope the group identity is bound to. Defaults to the host's root\n   * node (document or shadow root).\n   */\n  scopeOf?: (host: T) => GroupScope;\n};\n\n/** The membership of one host, attached to it as a reactive controller. */\ninterface GroupMemberController<\n  T extends GroupHost,\n> extends ReactiveController {\n  /** The hosts of this member's group, in DOM order. A host with no group is on its own. */\n  readonly members: T[];\n  /**\n   * Moves the host to the group of its current scope and key. Does nothing\n   * while both stay the same. If not, the group that the host joins and the\n   * group that it leaves both update their state.\n   */\n  updateMembership(): void;\n  /** Updates the state of the host group. */\n  sync(): void;\n}\n\ninterface GroupRegistry<T extends GroupHost, S> {\n  /** Creates and attaches a membership controller to the host. */\n  attach(host: T, onSync: (state: S) => void): GroupMemberController<T>;\n  /** Returns the hosts of the group of `member`, in DOM order. */\n  membersOf(member: T): T[];\n}\n\nfunction byDocumentOrder(a: Node, b: Node): number {\n  if (a === b) {\n    return 0;\n  }\n\n  return a.compareDocumentPosition(b) & Node.DOCUMENT_POSITION_FOLLOWING\n    ? -1\n    : 1;\n}\n\n/**\n * Creates a registry of groups whose members discover each other through a\n * shared scope and key instead of a common parent element - the way native\n * radio buttons group by their `name` within a form root.\n *\n * Each member holds its own entry for its life-cycle, so that a group read\n * reflects the actual membership and the members that stay behind derive their\n * state again when one leaves - a change a member cannot see on its own.\n *\n * One registry holds one kind of group; create it at module level:\n *\n * @example\n * ```typescript\n * const radioGroups = createGroupRegistry<IgcRadioComponent, boolean>({\n *   keyOf: (radio) => radio.name || '',\n *   deriveState: (radios) => radios.some((radio) => radio.checked),\n * });\n *\n * // In the component:\n * private readonly _group = radioGroups.attach(this, (state) => { ... });\n * ```\n */\nexport function createGroupRegistry<T extends GroupHost, S>(\n  config: GroupRegistryConfig<T, S>\n): GroupRegistry<T, S> {\n  const groups = new WeakMap<GroupScope, Map<string, Set<Member>>>();\n  const controllers = new WeakMap<T, Member>();\n\n  function scopeOf(host: T): GroupScope {\n    return config.scopeOf?.(host) ?? getRoot(host);\n  }\n\n  /** Gives each member of the group the state that the group derives. */\n  function syncGroup(group: Iterable<Member>): void {\n    const members = Array.from(group);\n    const state = config.deriveState(members.map((member) => member.host));\n\n    for (const member of members) {\n      member.onSync(state);\n    }\n  }\n\n  class Member implements GroupMemberController<T> {\n    public readonly host: T;\n    public readonly onSync: (state: S) => void;\n\n    /** The scope the host is registered under, or null while it is not registered. */\n    private _scope: GroupScope | null = null;\n    private _key = '';\n\n    /** Whether the host still belongs to the group that holds its entry. */\n    private get _isCurrent(): boolean {\n      return (\n        config.keyOf(this.host) === this._key &&\n        scopeOf(this.host) === this._scope\n      );\n    }\n\n    private get _group(): Member[] {\n      const entries = this._scope\n        ? Array.from(groups.get(this._scope)?.get(this._key) ?? [])\n        : [];\n\n      // A host moves to its new group on its next update, so an entry can be\n      // one that has a different key or scope by now.\n      const members = entries.filter((member) => member._isCurrent);\n\n      return isEmpty(members)\n        ? [this]\n        : members.sort((a, b) => byDocumentOrder(a.host, b.host));\n    }\n\n    public get members(): T[] {\n      return this._group.map((member) => member.host);\n    }\n\n    constructor(host: T, onSync: (state: S) => void) {\n      this.host = host;\n      this.onSync = onSync;\n\n      controllers.set(host, this);\n      host.addController(this);\n    }\n\n    public hostConnected(): void {\n      this.updateMembership();\n    }\n\n    public hostDisconnected(): void {\n      this._unregister();\n    }\n\n    public updateMembership(): void {\n      const scope = this.host.isConnected ? scopeOf(this.host) : null;\n      const key = config.keyOf(this.host);\n\n      if (scope === this._scope && key === this._key) {\n        return;\n      }\n\n      this._unregister();\n\n      if (scope && key) {\n        this._scope = scope;\n        this._key = key;\n\n        const keys = groups.get(scope) ?? new Map<string, Set<Member>>();\n        const group = keys.get(key) ?? new Set<Member>();\n\n        keys.set(key, group);\n        groups.set(scope, keys);\n        group.add(this);\n      }\n\n      this.sync();\n    }\n\n    public sync(): void {\n      syncGroup(this._group);\n    }\n\n    private _unregister(): void {\n      const { _scope: scope, _key: key } = this;\n      const keys = scope ? groups.get(scope) : undefined;\n      const group = keys?.get(key);\n\n      this._scope = null;\n      this._key = '';\n\n      if (!group?.delete(this)) {\n        return;\n      }\n\n      if (isEmpty(group)) {\n        keys?.delete(key);\n      } else {\n        // The host is gone, and any state that it held goes with it. What is\n        // left of the group derives its state again.\n        syncGroup(group);\n      }\n    }\n  }\n\n  return {\n    attach(host, onSync) {\n      return new Member(host, onSync);\n    },\n\n    membersOf(member) {\n      const controller = controllers.get(member);\n\n      // Move the member first, so that a read that comes right after a change\n      // of its key or scope resolves against the correct group.\n      controller?.updateMembership();\n\n      return controller?.members ?? [member];\n    },\n  };\n}\n\nexport type { GroupMemberController, GroupRegistry, GroupRegistryConfig };\n"]}

package/{components/common → internals}/controllers/id-resolver.js

@@ -1,5 +1,5 @@
 import { isServer } from 'lit';
-import { isDocument, isElement } from '../util.js';
+import { isDocument, isElement } from '../utils/dom.js';
 const ID_REF_EMITTERS = new WeakMap();
 const ID_REF_EVENT = 'id-refs-change';
 function getEmitter(root) {
@@ -10,6 +10,18 @@ function getEmitter(root) {
     }
     return emitter;
 }
+function collectIds(nodes, affected) {
+    for (const node of nodes) {
+        if (!isElement(node))
+            continue;
+        if (node.id)
+            affected.add(node.id);
+        for (const child of node.querySelectorAll('[id]')) {
+            if (child.id)
+                affected.add(child.id);
+        }
+    }
+}
 function refObserverCallback(mutations, emitter) {
     const affected = new Set();
     for (const mutation of mutations) {
@@ -24,26 +36,8 @@ function refObserverCallback(mutations, emitter) {
                 affected.add(newId);
         }
         else {
-            for (const node of mutation.addedNodes) {
-                if (!isElement(node))
-                    continue;
-                if (node.id)
-                    affected.add(node.id);
-                for (const child of node.querySelectorAll('[id]')) {
-                    if (child.id)
-                        affected.add(child.id);
-                }
-            }
-            for (const node of mutation.removedNodes) {
-                if (!isElement(node))
-                    continue;
-                if (node.id)
-                    affected.add(node.id);
-                for (const child of node.querySelectorAll('[id]')) {
-                    if (child.id)
-                        affected.add(child.id);
-                }
-            }
+            collectIds(mutation.addedNodes, affected);
+            collectIds(mutation.removedNodes, affected);
         }
     }
     if (affected.size > 0) {

package/internals/controllers/id-resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"id-resolver.js","sourceRoot":"","sources":["../../../src/internals/controllers/id-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAA4C,MAAM,KAAK,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAExD,MAAM,eAAe,GAAG,IAAI,OAAO,EAA4B,CAAC;AAChE,MAAM,YAAY,GAAG,gBAAgB,CAAC;AAEtC,SAAS,UAAU,CAAC,IAAU;IAC5B,IAAI,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACvC,eAAe,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACrC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAGD,SAAS,UAAU,CAAC,KAAe,EAAE,QAAqB;IACxD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAAE,SAAS;QAC/B,IAAI,IAAI,CAAC,EAAE;YAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,CAAC,EAAE;gBAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,SAA2B,EAC3B,OAA2B;IAE3B,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;IAEnC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACnC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,SAAS;YAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC;YAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YACjC,IAAI,KAAK;gBAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAC/B,IAAI,KAAK;gBAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAC1C,UAAU,CAAC,QAAQ,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAMD,MAAM,kBAAmB,SAAQ,WAAW;IAK1C,YAAY,IAAU;QACpB,KAAK,EAAE,CAAC;QAHF,cAAS,GAAG,CAAC,CAAC;QAIpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,CAAC,SAAS,EAAE,EAAE,CAClD,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,CACrC,CAAC;QACJ,CAAC;IACH,CAAC;IAKM,MAAM;QACX,IAAI,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;YACnE,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE;gBAC5B,eAAe,EAAE,CAAC,IAAI,CAAC;gBACvB,iBAAiB,EAAE,IAAI;gBACvB,OAAO,EAAE,IAAI;gBACb,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAKM,OAAO;QACZ,IAAI,IAAI,CAAC,SAAS,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;YACjD,IAAI,CAAC,SAAS,EAAE,UAAU,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;CACF;AAMD,MAAM,uBAAuB;IAO3B,YAAY,IAAgB,EAAE,QAAuC;QAJ7D,YAAO,GAAG,KAAK,CAAC;QAChB,eAAU,GAAG,KAAK,CAAC;QACnB,aAAQ,GAA8B,IAAI,CAAC;QAGjD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAEO,QAAQ;QACd,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;QACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACvB,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;IACrD,CAAC;IAEO,UAAU;QAChB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YACtD,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;IACH,CAAC;IAGM,WAAW,CAAC,KAAY;QAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAG,KAAkC,CAAC,MAAM,CAAC,CAAC;IAC9E,CAAC;IAGM,aAAa;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAGM,gBAAgB;QACrB,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAGM,OAAO;QACZ,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,CAAC;IACH,CAAC;IAGM,SAAS;QACd,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO;QAC1B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,CAAC;IACH,CAAC;CACF;AAMD,MAAM,UAAU,gBAAgB,CAC9B,IAAgB,EAChB,QAAuC;IAEvC,OAAO,IAAI,uBAAuB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACrD,CAAC","sourcesContent":["import { isServer, type LitElement, type ReactiveController } from 'lit';\nimport { isDocument, isElement } from '../utils/dom.js';\n\nconst ID_REF_EMITTERS = new WeakMap<Node, IdRefChangeEmitter>();\nconst ID_REF_EVENT = 'id-refs-change';\n\nfunction getEmitter(root: Node): IdRefChangeEmitter {\n  let emitter = ID_REF_EMITTERS.get(root);\n  if (!emitter) {\n    emitter = new IdRefChangeEmitter(root);\n    ID_REF_EMITTERS.set(root, emitter);\n  }\n  return emitter;\n}\n\n/** Adds the ids of `nodes` and of any of their descendants to `affected`. */\nfunction collectIds(nodes: NodeList, affected: Set<string>): void {\n  for (const node of nodes) {\n    if (!isElement(node)) continue;\n    if (node.id) affected.add(node.id);\n    for (const child of node.querySelectorAll('[id]')) {\n      if (child.id) affected.add(child.id);\n    }\n  }\n}\n\nfunction refObserverCallback(\n  mutations: MutationRecord[],\n  emitter: IdRefChangeEmitter\n): void {\n  const affected = new Set<string>();\n\n  for (const mutation of mutations) {\n    if (mutation.type === 'attributes') {\n      if (!isElement(mutation.target)) continue;\n      const oldId = mutation.oldValue;\n      const newId = mutation.target.id;\n      if (oldId) affected.add(oldId);\n      if (newId) affected.add(newId);\n    } else {\n      collectIds(mutation.addedNodes, affected);\n      collectIds(mutation.removedNodes, affected);\n    }\n  }\n\n  if (affected.size > 0) {\n    emitter.dispatchEvent(new CustomEvent(ID_REF_EVENT, { detail: affected }));\n  }\n}\n\n/**\n * Emits events when ID references in a root node change, allowing components to reactively update resolved references.\n * Uses a reference counting mechanism to avoid unnecessary observation when no components are using it.\n */\nclass IdRefChangeEmitter extends EventTarget {\n  private readonly _observer?: MutationObserver;\n  private readonly _root: Node;\n  private _refCount = 0;\n\n  constructor(root: Node) {\n    super();\n    this._root = root;\n\n    if (!isServer) {\n      this._observer = new MutationObserver((mutations) =>\n        refObserverCallback(mutations, this)\n      );\n    }\n  }\n\n  /**\n   * Increment the reference count. Starts the underlying MutationObserver on the first call.\n   */\n  public retain(): void {\n    if (this._refCount++ === 0) {\n      const root = isDocument(this._root) ? this._root.body : this._root;\n      this._observer?.observe(root, {\n        attributeFilter: ['id'],\n        attributeOldValue: true,\n        subtree: true,\n        childList: true,\n      });\n    }\n  }\n\n  /**\n   * Decrement the reference count. Stops the underlying MutationObserver when the count reaches zero.\n   */\n  public release(): void {\n    if (this._refCount > 0 && --this._refCount === 0) {\n      this._observer?.disconnect();\n    }\n  }\n}\n\n/**\n * Reactive controller that allows a host component to resolve ID references\n * scoped to its root node, and react to changes in those references.\n */\nclass IdRefResolverController implements ReactiveController {\n  private readonly _host: LitElement;\n  private readonly _callback: (ids: Set<string>) => unknown;\n  private _active = false;\n  private _connected = false;\n  private _emitter: IdRefChangeEmitter | null = null;\n\n  constructor(host: LitElement, callback: (ids: Set<string>) => unknown) {\n    this._host = host;\n    this._host.addController(this);\n    this._callback = callback;\n  }\n\n  private _observe(): void {\n    const root = this._host.getRootNode();\n    this._emitter = getEmitter(root);\n    this._emitter.retain();\n    this._emitter.addEventListener(ID_REF_EVENT, this);\n  }\n\n  private _unobserve(): void {\n    if (this._emitter) {\n      this._emitter.removeEventListener(ID_REF_EVENT, this);\n      this._emitter.release();\n      this._emitter = null;\n    }\n  }\n\n  /** @internal */\n  public handleEvent(event: Event): void {\n    this._callback.call(this._host, (event as CustomEvent<Set<string>>).detail);\n  }\n\n  /** @internal */\n  public hostConnected(): void {\n    this._connected = true;\n    if (this._active) {\n      this._observe();\n    }\n  }\n\n  /** @internal */\n  public hostDisconnected(): void {\n    if (this._active) {\n      this._unobserve();\n    }\n    this._connected = false;\n  }\n\n  /** Start tracking ID reference changes in the document. */\n  public observe(): void {\n    if (this._active) return;\n    this._active = true;\n    if (this._connected) {\n      this._observe();\n    }\n  }\n\n  /** Stop tracking ID reference changes in the document. */\n  public unobserve(): void {\n    if (!this._active) return;\n    this._active = false;\n    if (this._connected) {\n      this._unobserve();\n    }\n  }\n}\n\n/**\n * Adds an ID reference resolver controller to the host component, allowing it to resolve ID references scoped to\n * its root node and react to changes in those references.\n */\nexport function addIdRefResolver(\n  host: LitElement,\n  callback: (ids: Set<string>) => unknown\n): IdRefResolverController {\n  return new IdRefResolverController(host, callback);\n}\n\nexport type { IdRefResolverController };\n"]}

package/{components/common → internals}/controllers/internals.d.ts

@@ -1,17 +1,41 @@
-import type { LitElement, ReactiveControllerHost } from 'lit';
+import type { LitElement, ReactiveController, ReactiveControllerHost } from 'lit';
 import type { FormValueType } from '../mixins/forms/types.js';
+/** A subset of the ARIA attributes exposed through `ElementInternals`. */
+type ARIAState = {
+    [K in keyof ARIAMixin]?: ARIAMixin[K];
+};
 /** Configuration for the ElementInternalsController. */
 type ElementInternalsConfig<T extends keyof ARIAMixin = keyof ARIAMixin> = {
     /** Initial ARIA attributes to set on the element internals. */
-    initialARIA: Partial<Record<T, ARIAMixin[T]>>;
+    initialARIA?: Partial<Record<T, ARIAMixin[T]>>;
+    /**
+     * ARIA attributes derived from host state, recomputed on every host update.
+     * Keep the projection cheap - it runs whether or not the properties it reads
+     * have changed.
+     */
+    aria?: () => ARIAState;
+    /**
+     * Whether to also mirror the internals `role` to a `role` content attribute
+     * on the host element.
+     *
+     * Workaround for axe, which reads content attributes only and does not see
+     * `ElementInternals` ARIA. An author-supplied `role` attribute always wins -
+     * the controller only writes the attribute when it is absent or was written
+     * by the controller itself.
+     */
+    reflectRole?: boolean;
 };
 /**
  * A Lit ReactiveController to manage `ElementInternals` for a host element.
  * Provides methods to interact with custom element states and ARIA attributes..
  */
-declare class ElementInternalsController {
+declare class ElementInternalsController implements ReactiveController {
     private readonly _host;
     private readonly _internals;
+    private readonly _aria?;
+    private readonly _reflectRole;
+    /** The last `role` content attribute value written by this controller. */
+    private _reflectedRole;
     /**
      * Gets the closest ancestor `<form>` element or `null`.
      *
@@ -56,8 +80,25 @@ declare class ElementInternalsController {
      */
     get labels(): ReadonlyArray<Element> | null;
     constructor(host: ReactiveControllerHost & LitElement, config?: ElementInternalsConfig);
+    /** @internal */
+    hostConnected(): void;
+    /** @internal */
+    hostUpdate(): void;
+    /**
+     * Mirrors the internals `role` onto a content attribute on the host, when
+     * {@link ElementInternalsConfig.reflectRole} is enabled.
+     *
+     * Deferred until the host is connected - custom elements must not gain
+     * attributes during construction.
+     */
+    private _reflectRoleAttribute;
     /** Sets ARIA attributes on the element's internals. */
     setARIA<T extends keyof ARIAMixin = keyof ARIAMixin>(state: Partial<Record<T, ARIAMixin[T]>>): void;
+    /**
+     * Returns an ARIA attribute set on the element's internals. Internals-based
+     * ARIA leaves no trace in the DOM, so this is the only way to read it back.
+     */
+    getARIA<T extends keyof ARIAMixin = keyof ARIAMixin>(name: T): ARIAMixin[T];
     /**
      * Adds or removes a custom state from the element's internals.
      * Custom states can be styled via `:state()` selector in CSS.
@@ -103,4 +144,12 @@ declare class ElementInternalsController {
 }
 /** Creates and adds a {@link ElementInternalsController} to a LitElement host. */
 export declare function addInternalsController(host: ReactiveControllerHost & LitElement, config?: ElementInternalsConfig): ElementInternalsController;
+/**
+ * Resolves the {@link ElementInternalsController} of the given element, if it has one.
+ *
+ * Internal cross-component/spec lookup. Not part of the public API - lives under
+ * `#internals` and must not be re-exported from the package entry point. Prefer this
+ * over exposing `public` `@hidden @internal` members on component classes.
+ */
+export declare function internalsOf(element: Element): ElementInternalsController | undefined;
 export type { ElementInternalsController };

package/{components/common → internals}/controllers/internals.js

@@ -1,3 +1,4 @@
+const registry = new WeakMap();
 class ElementInternalsController {
     get form() {
         return this._internals.form;
@@ -16,15 +17,46 @@ class ElementInternalsController {
         return labels && labels.length > 0 ? Array.from(labels) : null;
     }
     constructor(host, config) {
+        this._reflectedRole = null;
         this._host = host;
         this._internals = this._host.attachInternals();
+        this._aria = config?.aria;
+        this._reflectRole = config?.reflectRole ?? false;
         if (config?.initialARIA) {
             this.setARIA(config.initialARIA);
         }
+        registry.set(host, this);
         host.addController(this);
     }
+    hostConnected() {
+        this._reflectRoleAttribute();
+    }
+    hostUpdate() {
+        if (this._aria) {
+            this.setARIA(this._aria.call(this._host));
+        }
+    }
+    _reflectRoleAttribute() {
+        const host = this._host;
+        if (!(this._reflectRole && host.isConnected)) {
+            return;
+        }
+        const role = this._internals.role;
+        const current = host.getAttribute('role');
+        if (current !== null && current !== this._reflectedRole) {
+            return;
+        }
+        role ? host.setAttribute('role', role) : host.removeAttribute('role');
+        this._reflectedRole = role;
+    }
     setARIA(state) {
         Object.assign(this._internals, state);
+        if ('role' in state) {
+            this._reflectRoleAttribute();
+        }
+    }
+    getARIA(name) {
+        return this._internals[name];
     }
     setState(state, value) {
         value
@@ -47,4 +79,7 @@ class ElementInternalsController {
 export function addInternalsController(host, config) {
     return new ElementInternalsController(host, config);
 }
+export function internalsOf(element) {
+    return registry.get(element);
+}
 //# sourceMappingURL=internals.js.map

package/internals/controllers/internals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internals.js","sourceRoot":"","sources":["../../../src/internals/controllers/internals.ts"],"names":[],"mappings":"AAsCA,MAAM,QAAQ,GAAG,IAAI,OAAO,EAAuC,CAAC;AAMpE,MAAM,0BAA0B;IAgB9B,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;IAC9B,CAAC;IAUD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IAClC,CAAC;IASD,IAAW,iBAAiB;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAC3C,CAAC;IAUD,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;IACtC,CAAC;IAUD,IAAW,MAAM;QACf,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAoC,CAAC;QACpE,OAAO,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjE,CAAC;IAED,YACE,IAAyC,EACzC,MAA+B;QA/DzB,mBAAc,GAAkB,IAAI,CAAC;QAiE3C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,CAAC;QAC/C,IAAI,CAAC,KAAK,GAAG,MAAM,EAAE,IAAI,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,MAAM,EAAE,WAAW,IAAI,KAAK,CAAC;QAEjD,IAAI,MAAM,EAAE,WAAW,EAAE,CAAC;YACxB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACnC,CAAC;QAED,QAAQ,CAAC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACzB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAGM,aAAa;QAClB,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAGM,UAAU;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IASO,qBAAqB;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;QAExB,IAAI,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC7C,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAI1C,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;YACxD,OAAO;QACT,CAAC;QAID,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QACtE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAGM,OAAO,CACZ,KAAuC;QAEvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QAEtC,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YACpB,IAAI,CAAC,qBAAqB,EAAE,CAAC;QAC/B,CAAC;IACH,CAAC;IAMM,OAAO,CACZ,IAAO;QAEP,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAMM,QAAQ,CAAC,KAAa,EAAE,KAAc;QAC3C,KAAK;YACH,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC;YACnC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC3C,CAAC;IAWM,YAAY,CAAC,KAAoB,EAAE,KAAqB;QAC7D,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAUM,WAAW,CAAC,KAA0B,EAAE,OAAgB;QAC7D,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAUM,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;IACzC,CAAC;IAUM,cAAc;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC;IAC1C,CAAC;CACF;AAGD,MAAM,UAAU,sBAAsB,CACpC,IAAyC,EACzC,MAA+B;IAE/B,OAAO,IAAI,0BAA0B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AACtD,CAAC;AASD,MAAM,UAAU,WAAW,CACzB,OAAgB;IAEhB,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC","sourcesContent":["import type {\n  LitElement,\n  ReactiveController,\n  ReactiveControllerHost,\n} from 'lit';\nimport type { FormValueType } from '../mixins/forms/types.js';\n\n/** A subset of the ARIA attributes exposed through `ElementInternals`. */\ntype ARIAState = { [K in keyof ARIAMixin]?: ARIAMixin[K] };\n\n/** Configuration for the ElementInternalsController. */\ntype ElementInternalsConfig<T extends keyof ARIAMixin = keyof ARIAMixin> = {\n  /** Initial ARIA attributes to set on the element internals. */\n  initialARIA?: Partial<Record<T, ARIAMixin[T]>>;\n  /**\n   * ARIA attributes derived from host state, recomputed on every host update.\n   * Keep the projection cheap - it runs whether or not the properties it reads\n   * have changed.\n   */\n  aria?: () => ARIAState;\n  /**\n   * Whether to also mirror the internals `role` to a `role` content attribute\n   * on the host element.\n   *\n   * Workaround for axe, which reads content attributes only and does not see\n   * `ElementInternals` ARIA. An author-supplied `role` attribute always wins -\n   * the controller only writes the attribute when it is absent or was written\n   * by the controller itself.\n   */\n  reflectRole?: boolean;\n};\n\n/**\n * Internal registry resolving a host element to its internals controller.\n *\n * `attachInternals()` throws when called twice on the same element, so a host\n * maps to at most one controller.\n */\nconst registry = new WeakMap<Element, ElementInternalsController>();\n\n/**\n * A Lit ReactiveController to manage `ElementInternals` for a host element.\n * Provides methods to interact with custom element states and ARIA attributes..\n */\nclass ElementInternalsController implements ReactiveController {\n  private readonly _host: ReactiveControllerHost & LitElement;\n  private readonly _internals: ElementInternals;\n  private readonly _aria?: () => ARIAState;\n  private readonly _reflectRole: boolean;\n\n  /** The last `role` content attribute value written by this controller. */\n  private _reflectedRole: string | null = null;\n\n  /**\n   * Gets the closest ancestor `<form>` element or `null`.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true` in order to return the parent form.\n   */\n  public get form(): HTMLFormElement | null {\n    return this._internals.form;\n  }\n\n  /**\n   * Returns a `ValidityState` object which represents the different validity states\n   * the element can be in, with respect to constraint validation.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public get validity(): ValidityState {\n    return this._internals.validity;\n  }\n\n  /**\n   * Returns a string containing the validation message of this element.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public get validationMessage(): string {\n    return this._internals.validationMessage;\n  }\n\n  /**\n   * Returns a boolean value which returns true if the element is a submittable element\n   * which is a candidate for constraint validation.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public get willValidate(): boolean {\n    return this._internals.willValidate;\n  }\n\n  /**\n   * Returns a read-only array of the `<label>` elements associated with the host element, or `null` if there are no associated labels.\n   * The association is determined by the `for` attribute of `<label>` elements or by nesting the host element inside a `<label>`.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true` in order to return associated labels.\n   */\n  public get labels(): ReadonlyArray<Element> | null {\n    const labels = this._internals.labels as NodeListOf<Element> | null;\n    return labels && labels.length > 0 ? Array.from(labels) : null;\n  }\n\n  constructor(\n    host: ReactiveControllerHost & LitElement,\n    config?: ElementInternalsConfig\n  ) {\n    this._host = host;\n    this._internals = this._host.attachInternals();\n    this._aria = config?.aria;\n    this._reflectRole = config?.reflectRole ?? false;\n\n    if (config?.initialARIA) {\n      this.setARIA(config.initialARIA);\n    }\n\n    registry.set(host, this);\n    host.addController(this);\n  }\n\n  /** @internal */\n  public hostConnected(): void {\n    this._reflectRoleAttribute();\n  }\n\n  /** @internal */\n  public hostUpdate(): void {\n    if (this._aria) {\n      this.setARIA(this._aria.call(this._host));\n    }\n  }\n\n  /**\n   * Mirrors the internals `role` onto a content attribute on the host, when\n   * {@link ElementInternalsConfig.reflectRole} is enabled.\n   *\n   * Deferred until the host is connected - custom elements must not gain\n   * attributes during construction.\n   */\n  private _reflectRoleAttribute(): void {\n    const host = this._host;\n\n    if (!(this._reflectRole && host.isConnected)) {\n      return;\n    }\n\n    const role = this._internals.role;\n    const current = host.getAttribute('role');\n\n    // Write only when the attribute is absent or still holds the value this\n    // controller wrote - an attribute changed by the author is theirs to keep.\n    if (current !== null && current !== this._reflectedRole) {\n      return;\n    }\n\n    // A cleared role takes its attribute with it, or the host would keep\n    // semantics that its internals no longer report.\n    role ? host.setAttribute('role', role) : host.removeAttribute('role');\n    this._reflectedRole = role;\n  }\n\n  /** Sets ARIA attributes on the element's internals. */\n  public setARIA<T extends keyof ARIAMixin = keyof ARIAMixin>(\n    state: Partial<Record<T, ARIAMixin[T]>>\n  ): void {\n    Object.assign(this._internals, state);\n\n    if ('role' in state) {\n      this._reflectRoleAttribute();\n    }\n  }\n\n  /**\n   * Returns an ARIA attribute set on the element's internals. Internals-based\n   * ARIA leaves no trace in the DOM, so this is the only way to read it back.\n   */\n  public getARIA<T extends keyof ARIAMixin = keyof ARIAMixin>(\n    name: T\n  ): ARIAMixin[T] {\n    return this._internals[name];\n  }\n\n  /**\n   * Adds or removes a custom state from the element's internals.\n   * Custom states can be styled via `:state()` selector in CSS.\n   */\n  public setState(state: string, value: boolean): void {\n    value\n      ? this._internals.states.add(state)\n      : this._internals.states.delete(state);\n  }\n\n  /**\n   * Sets both the state and submission value of internals's target element to value.\n   *\n   * If value is null, the element won't participate in form submission.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public setFormValue(value: FormValueType, state?: FormValueType): void {\n    this._internals.setFormValue(value, state);\n  }\n\n  /**\n   * Sets the internal validity state of the host element as well as the validation\n   * message.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public setValidity(flags?: ValidityStateFlags, message?: string): void {\n    this._internals.setValidity(flags, message);\n  }\n\n  /**\n   * Checks the internal validity of the host element and fires an `invalid` event if\n   * the host element fails validation constraints.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public checkValidity(): boolean {\n    return this._internals.checkValidity();\n  }\n\n  /**\n   * Checks the internal validity of the host element and fires an `invalid` event if\n   * the host element fails validation constraints.\n   *\n   * @remarks\n   * The host element must be form associated, that is, it should have\n   * `static formAssociated = true`.\n   */\n  public reportValidity(): boolean {\n    return this._internals.reportValidity();\n  }\n}\n\n/** Creates and adds a {@link ElementInternalsController} to a LitElement host. */\nexport function addInternalsController(\n  host: ReactiveControllerHost & LitElement,\n  config?: ElementInternalsConfig\n): ElementInternalsController {\n  return new ElementInternalsController(host, config);\n}\n\n/**\n * Resolves the {@link ElementInternalsController} of the given element, if it has one.\n *\n * Internal cross-component/spec lookup. Not part of the public API - lives under\n * `#internals` and must not be re-exported from the package entry point. Prefer this\n * over exposing `public` `@hidden @internal` members on component classes.\n */\nexport function internalsOf(\n  element: Element\n): ElementInternalsController | undefined {\n  return registry.get(element);\n}\n\nexport type { ElementInternalsController };\n"]}

package/{components/common → internals}/controllers/key-bindings.d.ts

@@ -35,7 +35,7 @@ type KeyBindingSkipCallback = (node: Element, event: KeyboardEvent) => boolean;
 type KeyBindingTrigger = 'keydown' | 'keyup';
 /**
  * Configuration object for the controller.
- * @ignore
+ * @hidden
  */
 interface KeyBindingControllerOptions {
     /**
@@ -101,18 +101,21 @@ interface KeyBindingOptions {
      */
     stopPropagation?: boolean;
 }
+/** {@link MODIFIER_ENTRIES} as a lookup of modifier name to event property. */
+export declare const MODIFIER_EVENT_KEYS: Record<string, string>;
 /**
- * Maps internal modifier names to their corresponding `KeyboardEvent` boolean property names.
- * Needed because `ctrlKey` in the DOM is the property for the `'control'` modifier (not `'controlKey'`).
+ * Whether the event's key matches `key`, case-insensitively. Prefer this over
+ * comparing `event.key` directly - the key names of this module are lowercase,
+ * while real events carry the canonical casing (e.g. `Enter`).
  */
-export declare const MODIFIER_EVENT_KEYS: Record<string, string>;
+export declare function isKey(event: KeyboardEvent, key: string): boolean;
 /**
  * A controller for managing key bindings on a host element. It allows you to register handlers for specific key combinations,
  * with support for modifier keys and event options such as `preventDefault` and `stopPropagation`.
  *
  * The controller listens for keyboard events on the host element (or an optionally specified element) and invokes the appropriate handlers
  * when the registered key combinations are detected.
- *
+ * @hidden
  */
 declare class KeyBindingController implements ReactiveController {
     private static readonly _defaultOptions;