apex-grid 1.1.0 → 3.0.0

package/controllers/selection.js

@@ -0,0 +1,168 @@
+export const DEFAULT_SELECTION_CONFIG = Object.freeze({
+    enabled: false,
+    mode: 'multiple',
+    showCheckboxColumn: false,
+});
+export class SelectionController {
+    constructor(host) {
+        this.host = host;
+        this.selected = new Set();
+        this.anchor = null;
+        this.host.addController(this);
+    }
+    hostConnected() { }
+    get enabled() {
+        return Boolean(this.host.selection?.enabled);
+    }
+    get mode() {
+        return this.host.selection?.mode ?? DEFAULT_SELECTION_CONFIG.mode;
+    }
+    get showCheckboxColumn() {
+        return (this.enabled &&
+            (this.host.selection?.showCheckboxColumn ?? DEFAULT_SELECTION_CONFIG.showCheckboxColumn));
+    }
+    isSelected(row) {
+        return this.selected.has(row);
+    }
+    selectedRows() {
+        return Array.from(this.selected);
+    }
+    allSelected() {
+        const view = this.host.dataView;
+        if (view.length === 0)
+            return false;
+        return view.every((row) => this.selected.has(row));
+    }
+    someSelected() {
+        if (this.selected.size === 0)
+            return false;
+        if (this.allSelected())
+            return false;
+        return true;
+    }
+    async toggleRow(row) {
+        if (!this.enabled)
+            return false;
+        const next = new Set(this.selected);
+        if (next.has(row)) {
+            next.delete(row);
+        }
+        else {
+            if (this.mode === 'single')
+                next.clear();
+            next.add(row);
+        }
+        this.anchor = next.has(row) ? row : null;
+        return this.#commit(next);
+    }
+    async selectRow(row) {
+        if (!this.enabled)
+            return false;
+        const next = new Set(this.mode === 'single' ? [] : this.selected);
+        next.add(row);
+        this.anchor = row;
+        return this.#commit(next);
+    }
+    async deselectRow(row) {
+        if (!this.enabled)
+            return false;
+        if (!this.selected.has(row))
+            return true;
+        const next = new Set(this.selected);
+        next.delete(row);
+        return this.#commit(next);
+    }
+    async additiveToggle(row) {
+        if (!this.enabled)
+            return false;
+        if (this.mode === 'single')
+            return this.toggleRow(row);
+        const next = new Set(this.selected);
+        if (next.has(row)) {
+            next.delete(row);
+        }
+        else {
+            next.add(row);
+        }
+        this.anchor = next.has(row) ? row : this.anchor;
+        return this.#commit(next);
+    }
+    async rangeToggle(row) {
+        if (!this.enabled)
+            return false;
+        if (this.mode === 'single' || !this.anchor) {
+            return this.selectRow(row);
+        }
+        const pageItems = this.host.pageItems;
+        const startIdx = pageItems.indexOf(this.anchor);
+        const endIdx = pageItems.indexOf(row);
+        if (startIdx === -1 || endIdx === -1) {
+            return this.selectRow(row);
+        }
+        const [lo, hi] = startIdx < endIdx ? [startIdx, endIdx] : [endIdx, startIdx];
+        const next = new Set(this.selected);
+        for (let i = lo; i <= hi; i++) {
+            next.add(pageItems[i]);
+        }
+        return this.#commit(next);
+    }
+    async selectAll() {
+        if (!this.enabled || this.mode === 'single')
+            return false;
+        const next = new Set(this.host.dataView);
+        return this.#commit(next);
+    }
+    async clear() {
+        if (this.selected.size === 0)
+            return true;
+        return this.#commit(new Set());
+    }
+    async replaceSelection(rows) {
+        if (!this.enabled)
+            return false;
+        const next = new Set(this.mode === 'single' ? rows.slice(0, 1) : rows);
+        return this.#commit(next);
+    }
+    async #commit(next) {
+        const added = [];
+        const removed = [];
+        for (const row of next) {
+            if (!this.selected.has(row))
+                added.push(row);
+        }
+        for (const row of this.selected) {
+            if (!next.has(row))
+                removed.push(row);
+        }
+        if (added.length === 0 && removed.length === 0)
+            return true;
+        const proceed = this.host.emitEvent('rowSelecting', {
+            detail: {
+                added,
+                removed,
+                current: Array.from(this.selected),
+                next: Array.from(next),
+            },
+            cancelable: true,
+        });
+        if (!proceed)
+            return false;
+        this.selected = next;
+        this.host.requestUpdate();
+        const total = this.selected.size;
+        if (total === 0) {
+            this.host.announce('Selection cleared');
+        }
+        else if (added.length === 1 && removed.length === 0 && total === 1) {
+            this.host.announce('1 row selected');
+        }
+        else {
+            this.host.announce(`${total} rows selected`);
+        }
+        this.host.emitEvent('rowSelected', {
+            detail: { added, removed, selected: Array.from(this.selected) },
+        });
+        return true;
+    }
+}
+//# sourceMappingURL=selection.js.map

package/controllers/selection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection.js","sourceRoot":"","sources":["../../src/controllers/selection.ts"],"names":[],"mappings":"AAMA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,UAA2B;IACjC,kBAAkB,EAAE,KAAK;CAC1B,CAAC,CAAC;AAgBH,MAAM,OAAO,mBAAmB;IAU9B,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QARhC,aAAQ,GAAW,IAAI,GAAG,EAAE,CAAC;QAM7B,WAAM,GAAa,IAAI,CAAC;QAG7B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,aAAa,KAAI,CAAC;IAKzB,IAAW,OAAO;QAChB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAKD,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,IAAI,wBAAwB,CAAC,IAAI,CAAC;IACpE,CAAC;IAKD,IAAW,kBAAkB;QAC3B,OAAO,CACL,IAAI,CAAC,OAAO;YACZ,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,IAAI,wBAAwB,CAAC,kBAAkB,CAAC,CACzF,CAAC;IACJ,CAAC;IAKM,UAAU,CAAC,GAAM;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAKM,YAAY;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAMM,WAAW;QAChB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;QAChC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QACpC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAQ,CAAC,CAAC,CAAC;IAC1D,CAAC;IAMM,YAAY;QACjB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAC3C,IAAI,IAAI,CAAC,WAAW,EAAE;YAAE,OAAO,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAOM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;gBAAE,IAAI,CAAC,KAAK,EAAE,CAAC;YACzC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAMM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAKM,KAAK,CAAC,WAAW,CAAC,GAAM;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAOM,KAAK,CAAC,cAAc,CAAC,GAAM;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAOM,KAAK,CAAC,WAAW,CAAC,GAAM;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAA6B,CAAC;QAC1D,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,QAAQ,KAAK,CAAC,CAAC,IAAI,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,QAAQ,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAC7E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,KAAK,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAM,CAAC,CAAC;QAC9B,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAMM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAA4B,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAKM,KAAK,CAAC,KAAK;QAChB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;IACjC,CAAC;IAOM,KAAK,CAAC,gBAAgB,CAAC,IAAsB;QAClD,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE5D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE;YAClD,MAAM,EAAE;gBACN,KAAK;gBACL,OAAO;gBACP,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;aACvB;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAE3B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;QAE1B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QACjC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;QAC1C,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,gBAAgB,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE;YACjC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { ReactiveController } from 'lit';\nimport type { GridHost, SelectionMode } from '../internal/types.js';\n\n/**\n * The default selection configuration used when the grid has none set.\n */\nexport const DEFAULT_SELECTION_CONFIG = Object.freeze({\n  enabled: false,\n  mode: 'multiple' as SelectionMode,\n  showCheckboxColumn: false,\n});\n\n/**\n * Reactive controller backing row selection.\n *\n * @remarks\n * Selection state is reference-based — the controller holds a `Set` of row\n * data references so the selection survives sort / filter / pagination as\n * long as those operations preserve identities (the default in-place\n * pipeline does). Replacing {@link ApexGrid.data} wholesale will invalidate\n * any selected rows that are no longer present in the new array; consumers\n * should call {@link clear} or re-apply selection after such a change.\n *\n * Mutations go through the cancellable `rowSelecting` event and emit a\n * follow-up `rowSelected` event, mirroring the pattern used by editing.\n */\nexport class SelectionController<T extends object> implements ReactiveController {\n  /** Set of currently selected row data references. */\n  public selected: Set<T> = new Set();\n\n  /**\n   * Anchor row for Shift+click range selection. Set whenever a single row\n   * is toggled / picked so a follow-up Shift+click knows where to start.\n   */\n  public anchor: T | null = null;\n\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public hostConnected() {}\n\n  /**\n   * Whether selection is enabled at the grid level.\n   */\n  public get enabled(): boolean {\n    return Boolean(this.host.selection?.enabled);\n  }\n\n  /**\n   * The resolved selection mode (`'multiple'` if unset).\n   */\n  public get mode(): SelectionMode {\n    return this.host.selection?.mode ?? DEFAULT_SELECTION_CONFIG.mode;\n  }\n\n  /**\n   * Whether to render the built-in checkbox column.\n   */\n  public get showCheckboxColumn(): boolean {\n    return (\n      this.enabled &&\n      (this.host.selection?.showCheckboxColumn ?? DEFAULT_SELECTION_CONFIG.showCheckboxColumn)\n    );\n  }\n\n  /**\n   * Whether the given row is currently selected.\n   */\n  public isSelected(row: T): boolean {\n    return this.selected.has(row);\n  }\n\n  /**\n   * Returns the currently selected rows in insertion order.\n   */\n  public selectedRows(): T[] {\n    return Array.from(this.selected);\n  }\n\n  /**\n   * Whether every row in the current view ({@link ApexGrid.dataView}) is\n   * selected. Used by the header checkbox to render its \"all\" state.\n   */\n  public allSelected(): boolean {\n    const view = this.host.dataView;\n    if (view.length === 0) return false;\n    return view.every((row) => this.selected.has(row as T));\n  }\n\n  /**\n   * Whether some — but not all — rows in the current view are selected.\n   * Used to render the header checkbox in its indeterminate state.\n   */\n  public someSelected(): boolean {\n    if (this.selected.size === 0) return false;\n    if (this.allSelected()) return false;\n    return true;\n  }\n\n  /**\n   * Toggles selection of `row`. In `'single'` mode this either selects the\n   * row (replacing any previous selection) or deselects it if it was the\n   * only selected row.\n   */\n  public async toggleRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    const next = new Set(this.selected);\n    if (next.has(row)) {\n      next.delete(row);\n    } else {\n      if (this.mode === 'single') next.clear();\n      next.add(row);\n    }\n    this.anchor = next.has(row) ? row : null;\n    return this.#commit(next);\n  }\n\n  /**\n   * Adds `row` to the selection. In `'single'` mode the existing selection\n   * is cleared first.\n   */\n  public async selectRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    const next = new Set(this.mode === 'single' ? [] : this.selected);\n    next.add(row);\n    this.anchor = row;\n    return this.#commit(next);\n  }\n\n  /**\n   * Removes `row` from the selection.\n   */\n  public async deselectRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (!this.selected.has(row)) return true;\n    const next = new Set(this.selected);\n    next.delete(row);\n    return this.#commit(next);\n  }\n\n  /**\n   * Adds `row` to the selection without affecting other selected rows\n   * (`'multiple'` mode only). In `'single'` mode this behaves like\n   * {@link selectRow}.\n   */\n  public async additiveToggle(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (this.mode === 'single') return this.toggleRow(row);\n    const next = new Set(this.selected);\n    if (next.has(row)) {\n      next.delete(row);\n    } else {\n      next.add(row);\n    }\n    this.anchor = next.has(row) ? row : this.anchor;\n    return this.#commit(next);\n  }\n\n  /**\n   * Selects every row between {@link anchor} and `row` (inclusive) in the\n   * current page view. No-op in `'single'` mode or when no anchor is set —\n   * in those cases the call falls back to a plain {@link selectRow}.\n   */\n  public async rangeToggle(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (this.mode === 'single' || !this.anchor) {\n      return this.selectRow(row);\n    }\n    const pageItems = this.host.pageItems as ReadonlyArray<T>;\n    const startIdx = pageItems.indexOf(this.anchor);\n    const endIdx = pageItems.indexOf(row);\n    if (startIdx === -1 || endIdx === -1) {\n      return this.selectRow(row);\n    }\n    const [lo, hi] = startIdx < endIdx ? [startIdx, endIdx] : [endIdx, startIdx];\n    const next = new Set(this.selected);\n    for (let i = lo; i <= hi; i++) {\n      next.add(pageItems[i] as T);\n    }\n    return this.#commit(next);\n  }\n\n  /**\n   * Selects every row currently in view ({@link ApexGrid.dataView}). No-op\n   * in `'single'` mode.\n   */\n  public async selectAll(): Promise<boolean> {\n    if (!this.enabled || this.mode === 'single') return false;\n    const next = new Set(this.host.dataView as ReadonlyArray<T>);\n    return this.#commit(next);\n  }\n\n  /**\n   * Clears the selection.\n   */\n  public async clear(): Promise<boolean> {\n    if (this.selected.size === 0) return true;\n    return this.#commit(new Set());\n  }\n\n  /**\n   * Replaces the current selection with `rows`. Used by the public\n   * {@link ApexGrid.selectedRows} setter so callers can drive selection\n   * programmatically. Single-mode keeps at most one row.\n   */\n  public async replaceSelection(rows: ReadonlyArray<T>): Promise<boolean> {\n    if (!this.enabled) return false;\n    const next = new Set(this.mode === 'single' ? rows.slice(0, 1) : rows);\n    return this.#commit(next);\n  }\n\n  async #commit(next: Set<T>): Promise<boolean> {\n    const added: T[] = [];\n    const removed: T[] = [];\n    for (const row of next) {\n      if (!this.selected.has(row)) added.push(row);\n    }\n    for (const row of this.selected) {\n      if (!next.has(row)) removed.push(row);\n    }\n    if (added.length === 0 && removed.length === 0) return true;\n\n    const proceed = this.host.emitEvent('rowSelecting', {\n      detail: {\n        added,\n        removed,\n        current: Array.from(this.selected),\n        next: Array.from(next),\n      },\n      cancelable: true,\n    });\n    if (!proceed) return false;\n\n    this.selected = next;\n    this.host.requestUpdate();\n\n    const total = this.selected.size;\n    if (total === 0) {\n      this.host.announce('Selection cleared');\n    } else if (added.length === 1 && removed.length === 0 && total === 1) {\n      this.host.announce('1 row selected');\n    } else {\n      this.host.announce(`${total} rows selected`);\n    }\n\n    this.host.emitEvent('rowSelected', {\n      detail: { added, removed, selected: Array.from(this.selected) },\n    });\n    return true;\n  }\n}\n"]}

package/controllers/sort.js

@@ -1,4 +1,5 @@
 import { PIPELINE } from '../internal/constants.js';
+import { awaitChildUpdates, playKeyedFlip } from '../internal/flip.js';
 import { asArray } from '../internal/utils.js';
 export class SortController {
     constructor(host) {
@@ -63,10 +64,37 @@ export class SortController {
         if (!this.#isMultipleSort) {
             this.reset();
         }
+        const beforeRects = this.#captureRowRects();
         this._sort(expression);
         await this.host.updateComplete;
+        await awaitChildUpdates(this.host.rows);
+        this.#playRowFlip(beforeRects);
+        this.#announce(expression, column);
         this.#emitSortedEvent(expression);
     }
+    #announce(expression, column) {
+        const label = column.headerText ?? String(column.key);
+        const message = expression.direction === 'none'
+            ? `Sort cleared on ${label}`
+            : `Sorted by ${label} ${expression.direction}`;
+        this.host.announce(message);
+    }
+    #captureRowRects() {
+        const entries = [];
+        for (const row of this.host.rows) {
+            const el = row;
+            entries.push({ key: row.data, rect: el.getBoundingClientRect() });
+        }
+        return entries;
+    }
+    #playRowFlip(before) {
+        const rows = this.host.rows;
+        const byData = new Map();
+        for (const row of rows) {
+            byData.set(row.data, row);
+        }
+        playKeyedFlip(before, (data) => byData.get(data) ?? null, 'y');
+    }
     prepareExpression({ key, sort: options }) {
         if (this.state.has(key)) {
             const expr = this.state.get(key);

package/controllers/sort.js.map

@@ -1 +1 @@
-{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../src/controllers/sort.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAOpD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,MAAM,OAAO,cAAc;IACzB,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAIhC,UAAK,GAAiB,IAAI,GAAG,EAAE,CAAC;QAHrC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAID,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAED,mBAAmB,CAAC,OAA8C;QAChE,MAAM,IAAI,GAA0D;YAClE,aAAa,EAAE,KAAK;YACpB,QAAQ,EAAE,SAAS;SACpB,CAAC;QAEF,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7C,OAAO,IAAkC,CAAC;QAC5C,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YACzB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAA+B,CAAC;IACnC,CAAC;IAED,wBAAwB,CAAC,GAAY;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;QAE/C,OAAO;YACL,GAAG;YACH,SAAS,EAAE,WAAW;YACtB,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;SAChB,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,GAAsB;QAC7B,OAAO,IAAI,CAAC,eAAe;YACzB,CAAC,CAAC,GAAG,KAAK,WAAW;gBACnB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,GAAG,KAAK,YAAY;oBACpB,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,WAAW;YACjB,CAAC,CAAC,GAAG,KAAK,WAAW;gBACnB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,WAAW,CAAC;IACpB,CAAC;IAED,iBAAiB,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,gBAAgB,CAAC,MAAyB;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,cAAc,CAAC,UAA6B;QAC1C,UAAU,CAAC,SAAS,KAAK,MAAM;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YAC5B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,MAA8B;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAEM,iBAAiB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAA0B;QACrE,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;YAElC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;gBACzB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;gBACxC,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;aACrC,CAAC,CAAC;QACL,CAAC;QAGD,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAES,KAAK,CAAC,WAAoD;QAClE,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,IAAI,CAAC,WAAoD;QAC9D,IAAI,CAAC,KAAK,CACR,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CACzF,CACF,CAAC;IACJ,CAAC;IAEM,aAAa,KAAI,CAAC;CAC1B","sourcesContent":["import type { ReactiveController } from 'lit';\nimport { PIPELINE } from '../internal/constants.js';\nimport type {\n  ColumnConfiguration,\n  ColumnSortConfiguration,\n  GridHost,\n  Keys,\n} from '../internal/types.js';\nimport { asArray } from '../internal/utils.js';\nimport type { SortExpression, SortingDirection, SortState } from '../operations/sort/types.js';\n\nexport class SortController<T extends object> implements ReactiveController {\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public state: SortState<T> = new Map();\n\n  get #isMultipleSort() {\n    return this.host.sortConfiguration.multiple;\n  }\n\n  get #isTriStateSort() {\n    return this.host.sortConfiguration.triState;\n  }\n\n  #resolveSortOptions(options?: boolean | ColumnSortConfiguration<T>) {\n    const expr: Pick<SortExpression<T>, 'caseSensitive' | 'comparer'> = {\n      caseSensitive: false,\n      comparer: undefined,\n    };\n\n    if (!options || typeof options === 'boolean') {\n      return expr as Partial<SortExpression<T>>;\n    }\n\n    return Object.assign(expr, {\n      caseSensitive: options.caseSensitive,\n      comparer: options.comparer,\n    }) as Partial<SortExpression<T>>;\n  }\n\n  #createDefaultExpression(key: Keys<T>) {\n    const options = this.host.getColumn(key)?.sort;\n\n    return {\n      key,\n      direction: 'ascending',\n      ...this.#resolveSortOptions(options),\n    } as SortExpression<T>;\n  }\n\n  #orderBy(dir?: SortingDirection): SortingDirection {\n    return this.#isTriStateSort\n      ? dir === 'ascending'\n        ? 'descending'\n        : dir === 'descending'\n          ? 'none'\n          : 'ascending'\n      : dir === 'ascending'\n        ? 'descending'\n        : 'ascending';\n  }\n\n  #emitSortingEvent(detail: SortExpression<T>) {\n    return this.host.emitEvent('sorting', { detail, cancelable: true });\n  }\n\n  #emitSortedEvent(detail: SortExpression<T>) {\n    return this.host.emitEvent('sorted', { detail });\n  }\n\n  #setExpression(expression: SortExpression<T>) {\n    expression.direction === 'none'\n      ? this.reset(expression.key)\n      : this.state.set(expression.key, { ...expression });\n  }\n\n  public async sortFromHeaderClick(column: ColumnConfiguration<T>) {\n    const expression = this.prepareExpression(column);\n\n    if (!this.#emitSortingEvent(expression)) {\n      return;\n    }\n\n    if (!this.#isMultipleSort) {\n      this.reset();\n    }\n\n    this._sort(expression);\n\n    await this.host.updateComplete;\n    this.#emitSortedEvent(expression);\n  }\n\n  public prepareExpression({ key, sort: options }: ColumnConfiguration<T>): SortExpression<T> {\n    if (this.state.has(key)) {\n      const expr = this.state.get(key)!;\n\n      return Object.assign(expr, {\n        direction: this.#orderBy(expr.direction),\n        ...this.#resolveSortOptions(options),\n      });\n    }\n\n    // Initial state\n    return this.#createDefaultExpression(key);\n  }\n\n  public reset(key?: Keys<T>) {\n    key ? this.state.delete(key) : this.state.clear();\n  }\n\n  protected _sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    for (const expr of asArray(expressions)) {\n      this.#setExpression(expr);\n    }\n\n    this.host.requestUpdate(PIPELINE);\n  }\n\n  public sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    this._sort(\n      asArray(expressions).map((expr) =>\n        Object.assign(this.state.get(expr.key) ?? this.#createDefaultExpression(expr.key), expr)\n      )\n    );\n  }\n\n  public hostConnected() {}\n}\n"]}
+{"version":3,"file":"sort.js","sourceRoot":"","sources":["../../src/controllers/sort.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAuB,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAO5F,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,MAAM,OAAO,cAAc;IACzB,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAIhC,UAAK,GAAiB,IAAI,GAAG,EAAE,CAAC;QAHrC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAID,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC;IAC9C,CAAC;IAED,mBAAmB,CAAC,OAA8C;QAChE,MAAM,IAAI,GAA0D;YAClE,aAAa,EAAE,KAAK;YACpB,QAAQ,EAAE,SAAS;SACpB,CAAC;QAEF,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,SAAS,EAAE,CAAC;YAC7C,OAAO,IAAkC,CAAC;QAC5C,CAAC;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;YACzB,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAA+B,CAAC;IACnC,CAAC;IAED,wBAAwB,CAAC,GAAY;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;QAE/C,OAAO;YACL,GAAG;YACH,SAAS,EAAE,WAAW;YACtB,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;SAChB,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,GAAsB;QAC7B,OAAO,IAAI,CAAC,eAAe;YACzB,CAAC,CAAC,GAAG,KAAK,WAAW;gBACnB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,GAAG,KAAK,YAAY;oBACpB,CAAC,CAAC,MAAM;oBACR,CAAC,CAAC,WAAW;YACjB,CAAC,CAAC,GAAG,KAAK,WAAW;gBACnB,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,WAAW,CAAC;IACpB,CAAC;IAED,iBAAiB,CAAC,MAAyB;QACzC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED,gBAAgB,CAAC,MAAyB;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,cAAc,CAAC,UAA6B;QAC1C,UAAU,CAAC,SAAS,KAAK,MAAM;YAC7B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC;YAC5B,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;IACxD,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,MAA8B;QAC7D,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QAMD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE5C,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAEvB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC;QAI/B,MAAM,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC/B,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,CAAC,UAA6B,EAAE,MAA8B;QACrE,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACtD,MAAM,OAAO,GACX,UAAU,CAAC,SAAS,KAAK,MAAM;YAC7B,CAAC,CAAC,mBAAmB,KAAK,EAAE;YAC5B,CAAC,CAAC,aAAa,KAAK,IAAI,UAAU,CAAC,SAAS,EAAE,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED,gBAAgB;QACd,MAAM,OAAO,GAAwB,EAAE,CAAC;QACxC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACjC,MAAM,EAAE,GAAG,GAA6B,CAAC;YACzC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,qBAAqB,EAAE,EAAE,CAAC,CAAC;QACpE,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,YAAY,CAAC,MAAwC;QAGnD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,GAAG,EAAkB,CAAC;QACzC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,GAA6B,CAAC,CAAC;QACtD,CAAC;QACD,aAAa,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,GAAG,CAAC,CAAC;IACjE,CAAC;IAEM,iBAAiB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAA0B;QACrE,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;YAElC,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;gBACzB,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC;gBACxC,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;aACrC,CAAC,CAAC;QACL,CAAC;QAGD,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,GAAa;QACxB,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAES,KAAK,CAAC,WAAoD;QAClE,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC5B,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACpC,CAAC;IAEM,IAAI,CAAC,WAAoD;QAC9D,IAAI,CAAC,KAAK,CACR,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAChC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CACzF,CACF,CAAC;IACJ,CAAC;IAEM,aAAa,KAAI,CAAC;CAC1B","sourcesContent":["import type { ReactiveController } from 'lit';\nimport { PIPELINE } from '../internal/constants.js';\nimport { awaitChildUpdates, type KeyedFlipEntry, playKeyedFlip } from '../internal/flip.js';\nimport type {\n  ColumnConfiguration,\n  ColumnSortConfiguration,\n  GridHost,\n  Keys,\n} from '../internal/types.js';\nimport { asArray } from '../internal/utils.js';\nimport type { SortExpression, SortingDirection, SortState } from '../operations/sort/types.js';\n\nexport class SortController<T extends object> implements ReactiveController {\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public state: SortState<T> = new Map();\n\n  get #isMultipleSort() {\n    return this.host.sortConfiguration.multiple;\n  }\n\n  get #isTriStateSort() {\n    return this.host.sortConfiguration.triState;\n  }\n\n  #resolveSortOptions(options?: boolean | ColumnSortConfiguration<T>) {\n    const expr: Pick<SortExpression<T>, 'caseSensitive' | 'comparer'> = {\n      caseSensitive: false,\n      comparer: undefined,\n    };\n\n    if (!options || typeof options === 'boolean') {\n      return expr as Partial<SortExpression<T>>;\n    }\n\n    return Object.assign(expr, {\n      caseSensitive: options.caseSensitive,\n      comparer: options.comparer,\n    }) as Partial<SortExpression<T>>;\n  }\n\n  #createDefaultExpression(key: Keys<T>) {\n    const options = this.host.getColumn(key)?.sort;\n\n    return {\n      key,\n      direction: 'ascending',\n      ...this.#resolveSortOptions(options),\n    } as SortExpression<T>;\n  }\n\n  #orderBy(dir?: SortingDirection): SortingDirection {\n    return this.#isTriStateSort\n      ? dir === 'ascending'\n        ? 'descending'\n        : dir === 'descending'\n          ? 'none'\n          : 'ascending'\n      : dir === 'ascending'\n        ? 'descending'\n        : 'ascending';\n  }\n\n  #emitSortingEvent(detail: SortExpression<T>) {\n    return this.host.emitEvent('sorting', { detail, cancelable: true });\n  }\n\n  #emitSortedEvent(detail: SortExpression<T>) {\n    return this.host.emitEvent('sorted', { detail });\n  }\n\n  #setExpression(expression: SortExpression<T>) {\n    expression.direction === 'none'\n      ? this.reset(expression.key)\n      : this.state.set(expression.key, { ...expression });\n  }\n\n  public async sortFromHeaderClick(column: ColumnConfiguration<T>) {\n    const expression = this.prepareExpression(column);\n\n    if (!this.#emitSortingEvent(expression)) {\n      return;\n    }\n\n    if (!this.#isMultipleSort) {\n      this.reset();\n    }\n\n    // Capture visible-row rects keyed by data identity BEFORE the pipeline\n    // runs. After the new render the virtualizer will have repositioned\n    // rows; we use those captured rects as the \"First\" of a FLIP and\n    // animate each row from its old viewport position back to identity.\n    const beforeRects = this.#captureRowRects();\n\n    this._sort(expression);\n\n    await this.host.updateComplete;\n    // Wait for body row updates so the new data is committed to each row\n    // element before measuring the \"Last\" rect — otherwise the captured-\n    // before and measured-after rects match and the animation no-ops.\n    await awaitChildUpdates(this.host.rows);\n    this.#playRowFlip(beforeRects);\n    this.#announce(expression, column);\n    this.#emitSortedEvent(expression);\n  }\n\n  #announce(expression: SortExpression<T>, column: ColumnConfiguration<T>) {\n    const label = column.headerText ?? String(column.key);\n    const message =\n      expression.direction === 'none'\n        ? `Sort cleared on ${label}`\n        : `Sorted by ${label} ${expression.direction}`;\n    this.host.announce(message);\n  }\n\n  #captureRowRects(): KeyedFlipEntry<T>[] {\n    const entries: KeyedFlipEntry<T>[] = [];\n    for (const row of this.host.rows) {\n      const el = row as unknown as HTMLElement;\n      entries.push({ key: row.data, rect: el.getBoundingClientRect() });\n    }\n    return entries;\n  }\n\n  #playRowFlip(before: ReadonlyArray<KeyedFlipEntry<T>>) {\n    // After sort, the same data may be rendered by a different `<apex-grid-row>`\n    // DOM element (virtualizer recycles rows). Resolve by data identity.\n    const rows = this.host.rows;\n    const byData = new Map<T, HTMLElement>();\n    for (const row of rows) {\n      byData.set(row.data, row as unknown as HTMLElement);\n    }\n    playKeyedFlip(before, (data) => byData.get(data) ?? null, 'y');\n  }\n\n  public prepareExpression({ key, sort: options }: ColumnConfiguration<T>): SortExpression<T> {\n    if (this.state.has(key)) {\n      const expr = this.state.get(key)!;\n\n      return Object.assign(expr, {\n        direction: this.#orderBy(expr.direction),\n        ...this.#resolveSortOptions(options),\n      });\n    }\n\n    // Initial state\n    return this.#createDefaultExpression(key);\n  }\n\n  public reset(key?: Keys<T>) {\n    key ? this.state.delete(key) : this.state.clear();\n  }\n\n  protected _sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    for (const expr of asArray(expressions)) {\n      this.#setExpression(expr);\n    }\n\n    this.host.requestUpdate(PIPELINE);\n  }\n\n  public sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    this._sort(\n      asArray(expressions).map((expr) =>\n        Object.assign(this.state.get(expr.key) ?? this.#createDefaultExpression(expr.key), expr)\n      )\n    );\n  }\n\n  public hostConnected() {}\n}\n"]}

package/controllers/state.d.ts

@@ -1,21 +1,67 @@
 import type { ReactiveController } from 'lit';
+import type { GridFeatureModule } from '../internal/feature-module.js';
 import type { ActiveNode, GridHost } from '../internal/types.js';
+import { EditingController } from './editing.js';
+import { ExpansionController } from './expansion.js';
 import { FilterController } from './filter.js';
 import { NavigationController } from './navigation.js';
+import { PaginationController } from './pagination.js';
+import { ReorderController } from './reorder.js';
 import { ResizeController } from './resize.js';
+import { SelectionController } from './selection.js';
 import { SortController } from './sort.js';
+import { TreeController } from './tree.js';
 export declare class StateController<T extends object> implements ReactiveController {
+    #private;
     host: GridHost<T>;
+    private extraModules;
     sorting: SortController<T>;
     filtering: FilterController<T>;
     navigation: NavigationController<T>;
     resizing: ResizeController<T>;
+    pagination: PaginationController<T>;
+    reordering: ReorderController<T>;
+    editing: EditingController<T>;
+    selection: SelectionController<T>;
+    expansion: ExpansionController<T>;
+    tree: TreeController<T>;
+    /**
+     * Optional feature controllers contributed by {@link GridFeatureModule}s,
+     * keyed by module id. Empty for the community `<apex-grid>` element; populated
+     * by derived grids (e.g. `@apexcharts/grid-enterprise`) that pass modules to
+     * the constructor.
+     */
+    readonly modules: Map<string, ReactiveController>;
+    /**
+     * Current message in the grid's polite live region. Bound by the host's
+     * `renderLiveRegion()` template; mutated through {@link setAnnouncement}
+     * so screen readers re-announce on every change.
+     */
+    announcement: string;
+    /**
+     * Updates the polite live region's text. Repeats are forced to fire by
+     * appending a zero-width space — screen readers ignore unchanged content,
+     * so two identical sort announcements wouldn't otherwise be read aloud.
+     */
+    setAnnouncement(message: string): void;
     get active(): ActiveNode<T>;
     set active(node: ActiveNode<T>);
     get headerRow(): import("../components/header-row.js").default<T>;
     get scrollContainer(): import("../components/virtualizer.js").default;
-    constructor(host: GridHost<T>);
+    get paginator(): import("../components/paginator.js").default<T>;
+    get toolbar(): import("../components/toolbar.js").default<T>;
+    /**
+     * Cumulative pin offsets (in px) keyed by column key. Populated by the
+     * {@link GridDOMController} after each layout.
+     */
+    get pinOffsets(): Map<unknown, number>;
+    constructor(host: GridHost<T>, extraModules?: ReadonlyArray<GridFeatureModule<T>>);
     protected init(): void;
+    /**
+     * Look up a feature controller contributed by a {@link GridFeatureModule},
+     * by its module id. Returns `undefined` when no such module is registered.
+     */
+    module<C extends ReactiveController>(id: string): C | undefined;
     hostConnected(): void;
     hostUpdate(): void;
 }

package/controllers/state.js

@@ -1,9 +1,26 @@
 import { createContext } from '@lit/context';
+import { EditingController } from './editing.js';
+import { ExpansionController } from './expansion.js';
 import { FilterController } from './filter.js';
 import { NavigationController } from './navigation.js';
+import { PaginationController } from './pagination.js';
+import { ReorderController } from './reorder.js';
 import { ResizeController } from './resize.js';
+import { SelectionController } from './selection.js';
 import { SortController } from './sort.js';
+import { TreeController } from './tree.js';
 export class StateController {
+    #announceToken;
+    setAnnouncement(message) {
+        if (!message) {
+            this.announcement = '';
+            this.host.requestUpdate();
+            return;
+        }
+        this.#announceToken = (this.#announceToken + 1) % 2;
+        this.announcement = this.#announceToken ? message : `${message} `;
+        this.host.requestUpdate();
+    }
     get active() {
         return this.navigation.active;
     }
@@ -16,8 +33,22 @@ export class StateController {
     get scrollContainer() {
         return this.host.scrollContainer;
     }
-    constructor(host) {
+    get paginator() {
+        return this.host.paginator;
+    }
+    get toolbar() {
+        return this.host.toolbar;
+    }
+    get pinOffsets() {
+        const dom = this.host.DOM;
+        return dom?.pinOffsets ?? new Map();
+    }
+    constructor(host, extraModules = []) {
         this.host = host;
+        this.extraModules = extraModules;
+        this.modules = new Map();
+        this.announcement = '';
+        this.#announceToken = 0;
         this.host.addController(this);
         this.init();
     }
@@ -26,11 +57,27 @@ export class StateController {
         this.filtering = new FilterController(this.host);
         this.navigation = new NavigationController(this.host);
         this.resizing = new ResizeController(this.host);
+        this.pagination = new PaginationController(this.host);
+        this.reordering = new ReorderController(this.host);
+        this.editing = new EditingController(this.host);
+        this.selection = new SelectionController(this.host);
+        this.expansion = new ExpansionController(this.host);
+        this.tree = new TreeController(this.host);
+        for (const module of this.extraModules) {
+            if (this.modules.has(module.id))
+                continue;
+            this.modules.set(module.id, module.create(this.host));
+        }
+    }
+    module(id) {
+        return this.modules.get(id);
     }
     hostConnected() { }
     hostUpdate() {
         this.headerRow?.requestUpdate();
         this.scrollContainer?.requestUpdate();
+        this.paginator?.requestUpdate();
+        this.toolbar?.requestUpdate();
     }
 }
 export const gridStateContext = createContext('gridStateController');

package/controllers/state.js.map

@@ -1 +1 @@
-{"version":3,"file":"state.js","sourceRoot":"","sources":["../../src/controllers/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,OAAO,eAAe;IAM1B,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,IAAW,MAAM,CAAC,IAAmB;QACnC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAChC,CAAC;IAED,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,IAAW,eAAe;QAExB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;IACnC,CAAC;IAED,YAAmB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAClC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAES,IAAI;QACZ,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAEM,aAAa,KAAI,CAAC;IAElB,UAAU;QACf,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,aAAa,EAAE,CAAC;IACxC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAuB,qBAAqB,CAAC,CAAC","sourcesContent":["import { createContext } from '@lit/context';\nimport type { ReactiveController } from 'lit';\nimport type { ActiveNode, GridHost } from '../internal/types.js';\nimport { FilterController } from './filter.js';\nimport { NavigationController } from './navigation.js';\nimport { ResizeController } from './resize.js';\nimport { SortController } from './sort.js';\n\nexport class StateController<T extends object> implements ReactiveController {\n  public sorting!: SortController<T>;\n  public filtering!: FilterController<T>;\n  public navigation!: NavigationController<T>;\n  public resizing!: ResizeController<T>;\n\n  public get active() {\n    return this.navigation.active;\n  }\n\n  public set active(node: ActiveNode<T>) {\n    this.navigation.active = node;\n  }\n\n  public get headerRow() {\n    // @ts-expect-error - Protected member access\n    return this.host.headerRow;\n  }\n\n  public get scrollContainer() {\n    // @ts-expect-error - Protected member access\n    return this.host.scrollContainer;\n  }\n\n  constructor(public host: GridHost<T>) {\n    this.host.addController(this);\n    this.init();\n  }\n\n  protected init() {\n    this.sorting = new SortController(this.host);\n    this.filtering = new FilterController(this.host);\n    this.navigation = new NavigationController(this.host);\n    this.resizing = new ResizeController(this.host);\n  }\n\n  public hostConnected() {}\n\n  public hostUpdate(): void {\n    this.headerRow?.requestUpdate();\n    this.scrollContainer?.requestUpdate();\n  }\n}\n\nexport const gridStateContext = createContext<StateController<any>>('gridStateController');\n"]}
+{"version":3,"file":"state.js","sourceRoot":"","sources":["../../src/controllers/state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAI7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAE3C,MAAM,OAAO,eAAe;IA0B1B,cAAc,CAAK;IAOZ,eAAe,CAAC,OAAe;QACpC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,CAAC;QAClE,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5B,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAED,IAAW,MAAM,CAAC,IAAmB;QACnC,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC;IAChC,CAAC;IAED,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,IAAW,eAAe;QAExB,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC;IACnC,CAAC;IAED,IAAW,SAAS;QAElB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;IAC7B,CAAC;IAED,IAAW,OAAO;QAEhB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;IAC3B,CAAC;IAMD,IAAW,UAAU;QAEnB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAwD,CAAC;QAC/E,OAAO,GAAG,EAAE,UAAU,IAAI,IAAI,GAAG,EAAE,CAAC;IACtC,CAAC;IAED,YACS,IAAiB,EAChB,eAAoD,EAAE;QADvD,SAAI,GAAJ,IAAI,CAAa;QAChB,iBAAY,GAAZ,YAAY,CAA0C;QAlEhD,YAAO,GAAG,IAAI,GAAG,EAA8B,CAAC;QAOzD,iBAAY,GAAG,EAAE,CAAC;QACzB,mBAAc,GAAG,CAAC,CAAC;QA4DjB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IAES,IAAI;QACZ,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,SAAS,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,QAAQ,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,GAAG,IAAI,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,UAAU,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,SAAS,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE1C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAAE,SAAS;YAC1C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAMM,MAAM,CAA+B,EAAU;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAkB,CAAC;IAC/C,CAAC;IAEM,aAAa,KAAI,CAAC;IAElB,UAAU;QACf,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;QAChC,IAAI,CAAC,eAAe,EAAE,aAAa,EAAE,CAAC;QACtC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,CAAC;QAChC,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,CAAC;IAChC,CAAC;CACF;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAuB,qBAAqB,CAAC,CAAC","sourcesContent":["import { createContext } from '@lit/context';\nimport type { ReactiveController } from 'lit';\nimport type { GridFeatureModule } from '../internal/feature-module.js';\nimport type { ActiveNode, GridHost } from '../internal/types.js';\nimport { EditingController } from './editing.js';\nimport { ExpansionController } from './expansion.js';\nimport { FilterController } from './filter.js';\nimport { NavigationController } from './navigation.js';\nimport { PaginationController } from './pagination.js';\nimport { ReorderController } from './reorder.js';\nimport { ResizeController } from './resize.js';\nimport { SelectionController } from './selection.js';\nimport { SortController } from './sort.js';\nimport { TreeController } from './tree.js';\n\nexport class StateController<T extends object> implements ReactiveController {\n  public sorting!: SortController<T>;\n  public filtering!: FilterController<T>;\n  public navigation!: NavigationController<T>;\n  public resizing!: ResizeController<T>;\n  public pagination!: PaginationController<T>;\n  public reordering!: ReorderController<T>;\n  public editing!: EditingController<T>;\n  public selection!: SelectionController<T>;\n  public expansion!: ExpansionController<T>;\n  public tree!: TreeController<T>;\n\n  /**\n   * Optional feature controllers contributed by {@link GridFeatureModule}s,\n   * keyed by module id. Empty for the community `<apex-grid>` element; populated\n   * by derived grids (e.g. `@apexcharts/grid-enterprise`) that pass modules to\n   * the constructor.\n   */\n  public readonly modules = new Map<string, ReactiveController>();\n\n  /**\n   * Current message in the grid's polite live region. Bound by the host's\n   * `renderLiveRegion()` template; mutated through {@link setAnnouncement}\n   * so screen readers re-announce on every change.\n   */\n  public announcement = '';\n  #announceToken = 0;\n\n  /**\n   * Updates the polite live region's text. Repeats are forced to fire by\n   * appending a zero-width space — screen readers ignore unchanged content,\n   * so two identical sort announcements wouldn't otherwise be read aloud.\n   */\n  public setAnnouncement(message: string): void {\n    if (!message) {\n      this.announcement = '';\n      this.host.requestUpdate();\n      return;\n    }\n    this.#announceToken = (this.#announceToken + 1) % 2;\n    this.announcement = this.#announceToken ? message : `${message} `;\n    this.host.requestUpdate();\n  }\n\n  public get active() {\n    return this.navigation.active;\n  }\n\n  public set active(node: ActiveNode<T>) {\n    this.navigation.active = node;\n  }\n\n  public get headerRow() {\n    // @ts-expect-error - Protected member access\n    return this.host.headerRow;\n  }\n\n  public get scrollContainer() {\n    // @ts-expect-error - Protected member access\n    return this.host.scrollContainer;\n  }\n\n  public get paginator() {\n    // @ts-expect-error - Protected member access\n    return this.host.paginator;\n  }\n\n  public get toolbar() {\n    // @ts-expect-error - Protected member access\n    return this.host.toolbar;\n  }\n\n  /**\n   * Cumulative pin offsets (in px) keyed by column key. Populated by the\n   * {@link GridDOMController} after each layout.\n   */\n  public get pinOffsets(): Map<unknown, number> {\n    // @ts-expect-error - Protected member access\n    const dom = this.host.DOM as { pinOffsets?: Map<unknown, number> } | undefined;\n    return dom?.pinOffsets ?? new Map();\n  }\n\n  constructor(\n    public host: GridHost<T>,\n    private extraModules: ReadonlyArray<GridFeatureModule<T>> = []\n  ) {\n    this.host.addController(this);\n    this.init();\n  }\n\n  protected init() {\n    this.sorting = new SortController(this.host);\n    this.filtering = new FilterController(this.host);\n    this.navigation = new NavigationController(this.host);\n    this.resizing = new ResizeController(this.host);\n    this.pagination = new PaginationController(this.host);\n    this.reordering = new ReorderController(this.host);\n    this.editing = new EditingController(this.host);\n    this.selection = new SelectionController(this.host);\n    this.expansion = new ExpansionController(this.host);\n    this.tree = new TreeController(this.host);\n\n    for (const module of this.extraModules) {\n      if (this.modules.has(module.id)) continue;\n      this.modules.set(module.id, module.create(this.host));\n    }\n  }\n\n  /**\n   * Look up a feature controller contributed by a {@link GridFeatureModule},\n   * by its module id. Returns `undefined` when no such module is registered.\n   */\n  public module<C extends ReactiveController>(id: string): C | undefined {\n    return this.modules.get(id) as C | undefined;\n  }\n\n  public hostConnected() {}\n\n  public hostUpdate(): void {\n    this.headerRow?.requestUpdate();\n    this.scrollContainer?.requestUpdate();\n    this.paginator?.requestUpdate();\n    this.toolbar?.requestUpdate();\n  }\n}\n\nexport const gridStateContext = createContext<StateController<any>>('gridStateController');\n"]}

package/controllers/tree.d.ts

@@ -0,0 +1,87 @@
+import type { ReactiveController } from 'lit';
+import type { GridHost, Keys } from '../internal/types.js';
+/**
+ * Default pixel indentation per depth level for the tree group column.
+ */
+export declare const DEFAULT_TREE_INDENT = 20;
+/**
+ * Tree metadata exposed to renderers. One entry per row that ends up in the
+ * flat output.
+ */
+export interface TreeRowMeta {
+    depth: number;
+    hasChildren: boolean;
+    /** Stable key for the row (path-joined string). Useful for keyed reconciliation. */
+    key: string;
+    /** Last path segment — used as the group-column label for synthesized parents. */
+    label: string;
+}
+/**
+ * Reactive controller backing tree (nested-row) data.
+ *
+ * @remarks
+ * Tree mode keeps the data array flat. Each row's hierarchy is derived from a
+ * user-supplied `getDataPath` callback (AG Grid's "tree data" pattern). The
+ * controller:
+ *
+ *  1. Builds an in-memory tree from the post-sort, post-filter rows.
+ *  2. Synthesizes parent nodes for any path level that lacks a backing row.
+ *  3. Walks the tree honouring the current expansion set and emits a flat
+ *     list of rows in display order.
+ *  4. Records per-row metadata (depth, hasChildren) that the cell renderer
+ *     reads to draw the chevron + indentation.
+ *
+ * Expansion state is split into two sets — `expanded` for rows that have
+ * backing data (keyed by reference, so it survives sort/filter), and
+ * `expandedKeys` for synthesized parents (keyed by their path string).
+ */
+export declare class TreeController<T extends object> implements ReactiveController {
+    #private;
+    protected host: GridHost<T>;
+    expanded: Set<T>;
+    expandedKeys: Set<string>;
+    constructor(host: GridHost<T>);
+    hostConnected(): void;
+    /** Whether tree mode is enabled at the grid level. */
+    get enabled(): boolean;
+    /** The configured indentation, in pixels, per depth level. */
+    get childIndent(): number;
+    /**
+     * The column key that displays the chevron + indentation. Resolves to the
+     * configured `groupColumnKey`, falling back to the first visible data column.
+     */
+    get groupColumnKey(): Keys<T> | undefined;
+    isGroupColumn(key: Keys<T>): boolean;
+    /**
+     * Per-row metadata. Populated as a side effect of {@link process}; reading
+     * before the first pipeline pass returns `undefined`.
+     */
+    getMeta(row: T): TreeRowMeta | undefined;
+    getDepth(row: T): number;
+    hasChildren(row: T): boolean;
+    isSynthesized(row: T): boolean;
+    /** Group-column label override for synthesized parent rows. */
+    getLabel(row: T): string | null;
+    isExpanded(row: T): boolean;
+    /** Toggles the expansion state of a tree row. */
+    toggleRow(row: T): Promise<boolean>;
+    expandRow(row: T): Promise<boolean>;
+    collapseRow(row: T): Promise<boolean>;
+    /** Expands every parent in the current tree. */
+    expandAll(): Promise<boolean>;
+    /** Collapses every currently-expanded row. */
+    collapseAll(): Promise<boolean>;
+    /**
+     * Pipeline entry point. Called by {@link DataOperationsController.apply}
+     * after sort/filter/quickFilter. Builds the tree, applies the configured
+     * defaults the first time we see this data, and returns rows in
+     * display-order with any synthesized parents inserted.
+     */
+    process(input: ReadonlyArray<T>): T[];
+    /**
+     * Resets cached metadata + defaults flag so the next pipeline pass
+     * re-applies `defaultExpanded`. Called from the data watcher when the
+     * input array is replaced wholesale.
+     */
+    resetForDataChange(): void;
+}

package/controllers/tree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../src/controllers/tree.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAKzD,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAGtC,MAAM,WAAW,GAAG,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAkDnD,MAAM,OAAO,cAAc;IAIzB,KAAK,CAAiC;IACtC,cAAc,CAAkC;IAEhD,cAAc,CAAwB;IAEtC,gBAAgB,CAAS;IAEzB,SAAS,CAA4B;IAErC,YAAsB,IAAiB;QAAjB,SAAI,GAAJ,IAAI,CAAa;QAZhC,aAAQ,GAAW,IAAI,GAAG,EAAE,CAAC;QAC7B,iBAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;QAE7C,UAAK,GAAG,IAAI,OAAO,EAAkB,CAAC;QACtC,mBAAc,GAAG,IAAI,GAAG,EAAuB,CAAC;QAEhD,mBAAc,GAAG,IAAI,GAAG,EAAa,CAAC;QAEtC,qBAAgB,GAAG,KAAK,CAAC;QAEzB,cAAS,GAAuB,IAAI,CAAC;QAGnC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAEM,aAAa,KAAI,CAAC;IAGzB,IAAW,OAAO;QAChB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACzE,CAAC;IAGD,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,IAAI,mBAAmB,CAAC;IAC5D,CAAC;IAMD,IAAW,cAAc;QACvB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC;QAClD,IAAI,UAAU;YAAE,OAAO,UAAU,CAAC;QAClC,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACxF,OAAO,SAAS,EAAE,GAAG,CAAC;IACxB,CAAC;IAEM,aAAa,CAAC,GAAY;QAC/B,OAAO,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,cAAc,KAAK,GAAG,CAAC;IACrD,CAAC;IAMM,OAAO,CAAC,GAAM;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEM,QAAQ,CAAC,GAAM;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;IACzC,CAAC;IAEM,WAAW,CAAC,GAAM;QACvB,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC;IACnD,CAAC;IAEM,aAAa,CAAC,GAAM;QACzB,OAAQ,GAAmC,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACpE,CAAC;IAGM,QAAQ,CAAC,GAAM;QACpB,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,GAAM;QACtB,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;YACrC,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QAClD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,CAAC;IAGM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzC,MAAM,WAAW,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IACnE,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,GAAM;QAC3B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACzC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;gBACrC,IAAI,GAAG;oBAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,GAAM;QAC7B,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACzC,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;gBACrC,IAAI,GAAG;oBAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAChC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAGM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,KAAK,CAAC;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACzC,MAAM,KAAK,GAAG,CAAC,IAAiB,EAAE,EAAE;gBAClC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC9C,IAAI,IAAI,CAAC,IAAI;wBAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;wBAClC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC9B,CAAC;gBACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;oBAAE,KAAK,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC;IAGM,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAChC,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,EAAE;YACzC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjB,QAAQ,CAAC,KAAK,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAQM,OAAO,CAAC,KAAuB;QACpC,IAAI,CAAC,IAAI,CAAC,OAAO;YAAE,OAAO,KAAY,CAAC;QAEvC,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC,WAAW,CAAC;QAChD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QAGtB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC/B,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAOM,kBAAkB;QACvB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC;IAIhC,CAAC;IAID,UAAU,CAAC,IAAsB,EAAE,WAA0C;QAC3E,MAAM,IAAI,GAAgB;YACxB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,EAAE;YACR,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,CAAC,CAAC;YACT,MAAM,EAAE,IAAI;YACZ,QAAQ,EAAE,EAAE;SACb,CAAC;QACF,MAAM,KAAK,GAAG,IAAI,GAAG,EAAuB,CAAC;QAC7C,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QAEpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAS;YAEjD,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACzC,MAAM,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;gBACrC,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,IAAI,GAAG;wBACL,IAAI,EAAE,IAAI;wBACV,IAAI,EAAE,GAAG;wBACT,GAAG;wBACH,KAAK,EAAE,CAAC;wBACR,MAAM;wBACN,QAAQ,EAAE,EAAE;qBACb,CAAC;oBACF,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;oBACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7B,CAAC;gBACD,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAI9B,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;gBAClB,CAAC;gBACD,MAAM,GAAG,IAAI,CAAC;YAChB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,cAAc,CAAC,IAAiB;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,eAAe,CAAC;QAChD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK;YAAE,OAAO;QACvD,MAAM,aAAa,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,CAAC;QACvF,MAAM,KAAK,GAAG,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,IAAI,aAAa,EAAE,CAAC;gBAC7E,IAAI,IAAI,CAAC,IAAI;oBAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;oBACvC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACvC,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;gBAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED,YAAY,CAAC,IAAiB;QAK5B,MAAM,KAAK,GAAG,CAAC,IAAiB,EAAE,EAAE;YAClC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,MAAM,IAAI,GAAgB;oBACxB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;oBACrC,GAAG,EAAE,IAAI,CAAC,GAAG;oBACb,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE;iBAC7C,CAAC;gBACF,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC;YACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;gBAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QACF,KAAK,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,IAAiB;QACxB,MAAM,GAAG,GAAQ,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,CAAC,IAAiB,EAAE,EAAE;YACjC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;oBACd,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;qBAAM,CAAC;oBAGN,IAAI,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBACpD,IAAI,CAAC,WAAW,EAAE,CAAC;wBACjB,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAM,CAAC;wBACvC,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE;4BAC9C,KAAK,EAAE,IAAI;4BACX,UAAU,EAAE,KAAK;yBAClB,CAAC,CAAC;wBACH,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;oBACjD,CAAC;oBACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAE,CAAC,CAAC;oBAChE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACxB,CAAC;YACH,CAAC;YACD,MAAM,QAAQ,GACZ,IAAI,KAAK,IAAI;gBACb,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/E,IAAI,QAAQ,EAAE,CAAC;gBACb,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ;oBAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACjD,CAAC;QACH,CAAC,CAAC;QACF,IAAI,CAAC,IAAI,CAAC,CAAC;QACX,OAAO,GAAG,CAAC;IACb,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,MAAyD;QACrE,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC5C,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE3B,MAAM,WAAW,GACf,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/F,MAAM,WAAW,GACf,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC,YAAY,CAAC,IAAI;YACxC,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,WAAW,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QAE9C,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,MAAM,OAAO,GAAQ,EAAE,CAAC;QACxB,KAAK,MAAM,GAAG,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzE,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ;YAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE3E,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE;YACtD,MAAM,EAAE;gBACN,KAAK;gBACL,OAAO;gBACP,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAClC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC;aAC3B;YACD,UAAU,EAAE,IAAI;SACjB,CAAC,CAAC;QACH,IAAI,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC;QAE3B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC;QAE7B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE;YACrC,MAAM,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SAChE,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["import type { ReactiveController } from 'lit';\nimport { PIPELINE } from '../internal/constants.js';\nimport type { GridHost, Keys } from '../internal/types.js';\nimport { getDisplayColumns } from '../internal/utils.js';\n\n/**\n * Default pixel indentation per depth level for the tree group column.\n */\nexport const DEFAULT_TREE_INDENT = 20;\n\n/** Sentinel value used to mark synthesized parents (those that exist only as a path segment, with no backing row). */\nconst SYNTHESIZED = Symbol('synthesized-tree-row');\n\n/**\n * Internal tree node. Built from the flat data + `getDataPath` callback;\n * lives only for the duration of one pipeline pass.\n */\ninterface TreeNode<T extends object> {\n  /** The backing row when one exists at this path, else `null` (synthesized parent). */\n  data: T | null;\n  /** Path segments from root to this node. */\n  path: readonly string[];\n  /** `path.join('\u0000')` — used as stable string identity for synthesized nodes. */\n  key: string;\n  depth: number;\n  parent: TreeNode<T> | null;\n  children: TreeNode<T>[];\n}\n\n/**\n * Tree metadata exposed to renderers. One entry per row that ends up in the\n * flat output.\n */\nexport interface TreeRowMeta {\n  depth: number;\n  hasChildren: boolean;\n  /** Stable key for the row (path-joined string). Useful for keyed reconciliation. */\n  key: string;\n  /** Last path segment — used as the group-column label for synthesized parents. */\n  label: string;\n}\n\n/**\n * Reactive controller backing tree (nested-row) data.\n *\n * @remarks\n * Tree mode keeps the data array flat. Each row's hierarchy is derived from a\n * user-supplied `getDataPath` callback (AG Grid's \"tree data\" pattern). The\n * controller:\n *\n *  1. Builds an in-memory tree from the post-sort, post-filter rows.\n *  2. Synthesizes parent nodes for any path level that lacks a backing row.\n *  3. Walks the tree honouring the current expansion set and emits a flat\n *     list of rows in display order.\n *  4. Records per-row metadata (depth, hasChildren) that the cell renderer\n *     reads to draw the chevron + indentation.\n *\n * Expansion state is split into two sets — `expanded` for rows that have\n * backing data (keyed by reference, so it survives sort/filter), and\n * `expandedKeys` for synthesized parents (keyed by their path string).\n */\nexport class TreeController<T extends object> implements ReactiveController {\n  public expanded: Set<T> = new Set();\n  public expandedKeys: Set<string> = new Set();\n\n  #meta = new WeakMap<T, TreeRowMeta>();\n  #syntheticMeta = new Map<string, TreeRowMeta>();\n  /** Synthesized parent placeholder rows so consumers still get a `T`-shaped object. */\n  #syntheticRows = new Map<string, T>();\n  /** Whether `defaultExpanded` has been applied once for the current data set. */\n  #defaultsApplied = false;\n  /** Most recently built root node. Used to walk the full tree for expand-all. */\n  #lastRoot: TreeNode<T> | null = null;\n\n  constructor(protected host: GridHost<T>) {\n    this.host.addController(this);\n  }\n\n  public hostConnected() {}\n\n  /** Whether tree mode is enabled at the grid level. */\n  public get enabled(): boolean {\n    return Boolean(this.host.tree?.enabled && this.host.tree?.getDataPath);\n  }\n\n  /** The configured indentation, in pixels, per depth level. */\n  public get childIndent(): number {\n    return this.host.tree?.childIndent ?? DEFAULT_TREE_INDENT;\n  }\n\n  /**\n   * The column key that displays the chevron + indentation. Resolves to the\n   * configured `groupColumnKey`, falling back to the first visible data column.\n   */\n  public get groupColumnKey(): Keys<T> | undefined {\n    const configured = this.host.tree?.groupColumnKey;\n    if (configured) return configured;\n    const displayed = getDisplayColumns(this.host.columns).find((column) => !column.hidden);\n    return displayed?.key;\n  }\n\n  public isGroupColumn(key: Keys<T>): boolean {\n    return this.enabled && this.groupColumnKey === key;\n  }\n\n  /**\n   * Per-row metadata. Populated as a side effect of {@link process}; reading\n   * before the first pipeline pass returns `undefined`.\n   */\n  public getMeta(row: T): TreeRowMeta | undefined {\n    return this.#meta.get(row);\n  }\n\n  public getDepth(row: T): number {\n    return this.#meta.get(row)?.depth ?? 0;\n  }\n\n  public hasChildren(row: T): boolean {\n    return Boolean(this.#meta.get(row)?.hasChildren);\n  }\n\n  public isSynthesized(row: T): boolean {\n    return (row as { [SYNTHESIZED]?: boolean })[SYNTHESIZED] === true;\n  }\n\n  /** Group-column label override for synthesized parent rows. */\n  public getLabel(row: T): string | null {\n    if (!this.isSynthesized(row)) return null;\n    return this.#meta.get(row)?.label ?? null;\n  }\n\n  public isExpanded(row: T): boolean {\n    if (this.isSynthesized(row)) {\n      const key = this.#meta.get(row)?.key;\n      return key ? this.expandedKeys.has(key) : false;\n    }\n    return this.expanded.has(row);\n  }\n\n  /** Toggles the expansion state of a tree row. */\n  public async toggleRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (!this.hasChildren(row)) return false;\n    const wasExpanded = this.isExpanded(row);\n    return wasExpanded ? this.collapseRow(row) : this.expandRow(row);\n  }\n\n  public async expandRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (!this.hasChildren(row)) return false;\n    if (this.isExpanded(row)) return true;\n    return this.#commit((nextData, nextKeys) => {\n      if (this.isSynthesized(row)) {\n        const key = this.#meta.get(row)?.key;\n        if (key) nextKeys.add(key);\n      } else {\n        nextData.add(row);\n      }\n    });\n  }\n\n  public async collapseRow(row: T): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (!this.isExpanded(row)) return true;\n    return this.#commit((nextData, nextKeys) => {\n      if (this.isSynthesized(row)) {\n        const key = this.#meta.get(row)?.key;\n        if (key) nextKeys.delete(key);\n      } else {\n        nextData.delete(row);\n      }\n    });\n  }\n\n  /** Expands every parent in the current tree. */\n  public async expandAll(): Promise<boolean> {\n    if (!this.enabled) return false;\n    const root = this.#lastRoot;\n    if (!root) return false;\n    return this.#commit((nextData, nextKeys) => {\n      const visit = (node: TreeNode<T>) => {\n        if (node !== root && node.children.length > 0) {\n          if (node.data) nextData.add(node.data);\n          else nextKeys.add(node.key);\n        }\n        for (const child of node.children) visit(child);\n      };\n      visit(root);\n    });\n  }\n\n  /** Collapses every currently-expanded row. */\n  public async collapseAll(): Promise<boolean> {\n    if (!this.enabled) return false;\n    if (this.expanded.size === 0 && this.expandedKeys.size === 0) return true;\n    return this.#commit((nextData, nextKeys) => {\n      nextData.clear();\n      nextKeys.clear();\n    });\n  }\n\n  /**\n   * Pipeline entry point. Called by {@link DataOperationsController.apply}\n   * after sort/filter/quickFilter. Builds the tree, applies the configured\n   * defaults the first time we see this data, and returns rows in\n   * display-order with any synthesized parents inserted.\n   */\n  public process(input: ReadonlyArray<T>): T[] {\n    if (!this.enabled) return input as T[];\n\n    const getDataPath = this.host.tree!.getDataPath;\n    const root = this.#buildTree(input, getDataPath);\n    this.#lastRoot = root;\n\n    // Apply defaultExpanded once per data set.\n    if (!this.#defaultsApplied) {\n      this.#applyDefaults(root);\n      this.#defaultsApplied = true;\n    }\n\n    this.#refreshMeta(root);\n    return this.#flatten(root);\n  }\n\n  /**\n   * Resets cached metadata + defaults flag so the next pipeline pass\n   * re-applies `defaultExpanded`. Called from the data watcher when the\n   * input array is replaced wholesale.\n   */\n  public resetForDataChange(): void {\n    this.#defaultsApplied = false;\n    // Don't clear `expanded`/`expandedKeys`; consumers may want them to\n    // survive across pipeline passes. If a wholesale data swap orphans\n    // references, those entries are simply ignored on the next pass.\n  }\n\n  // --- internals ---------------------------------------------------------\n\n  #buildTree(rows: ReadonlyArray<T>, getDataPath: (row: T) => readonly string[]): TreeNode<T> {\n    const root: TreeNode<T> = {\n      data: null,\n      path: [],\n      key: '',\n      depth: -1,\n      parent: null,\n      children: [],\n    };\n    const byKey = new Map<string, TreeNode<T>>();\n    byKey.set('', root);\n\n    for (const row of rows) {\n      const fullPath = getDataPath(row);\n      if (!fullPath || fullPath.length === 0) continue;\n\n      let parent = root;\n      for (let i = 0; i < fullPath.length; i++) {\n        const sub = fullPath.slice(0, i + 1);\n        const key = sub.join('\u0000');\n        let node = byKey.get(key);\n        if (!node) {\n          node = {\n            data: null,\n            path: sub,\n            key,\n            depth: i,\n            parent,\n            children: [],\n          };\n          byKey.set(key, node);\n          parent.children.push(node);\n        }\n        if (i === fullPath.length - 1) {\n          // The terminal segment is the actual record. If we previously\n          // saw a child path that synthesized this level, attach the data\n          // now.\n          node.data = row;\n        }\n        parent = node;\n      }\n    }\n\n    return root;\n  }\n\n  #applyDefaults(root: TreeNode<T>): void {\n    const setting = this.host.tree?.defaultExpanded;\n    if (setting === undefined || setting === false) return;\n    const expandToDepth = typeof setting === 'number' ? setting : Number.POSITIVE_INFINITY;\n    const visit = (node: TreeNode<T>) => {\n      if (node !== root && node.children.length > 0 && node.depth <= expandToDepth) {\n        if (node.data) this.expanded.add(node.data);\n        else this.expandedKeys.add(node.key);\n      }\n      for (const child of node.children) visit(child);\n    };\n    visit(root);\n  }\n\n  #refreshMeta(root: TreeNode<T>): void {\n    // Recompute meta for every node in the tree, both synthesized and\n    // backed. The metadata is fresh each pipeline pass since depth or\n    // hasChildren may have changed (rows reordered, filter dropped a\n    // descendant, etc.).\n    const visit = (node: TreeNode<T>) => {\n      if (node !== root) {\n        const meta: TreeRowMeta = {\n          depth: node.depth,\n          hasChildren: node.children.length > 0,\n          key: node.key,\n          label: node.path[node.path.length - 1] ?? '',\n        };\n        if (node.data) {\n          this.#meta.set(node.data, meta);\n        } else {\n          this.#syntheticMeta.set(node.key, meta);\n        }\n      }\n      for (const child of node.children) visit(child);\n    };\n    visit(root);\n  }\n\n  #flatten(root: TreeNode<T>): T[] {\n    const out: T[] = [];\n    const walk = (node: TreeNode<T>) => {\n      if (node !== root) {\n        if (node.data) {\n          out.push(node.data);\n        } else {\n          // Synthesize a `T`-shaped placeholder so callers don't trip on\n          // `null` rows. The placeholder carries the SYNTHESIZED marker.\n          let placeholder = this.#syntheticRows.get(node.key);\n          if (!placeholder) {\n            placeholder = Object.create(null) as T;\n            Object.defineProperty(placeholder, SYNTHESIZED, {\n              value: true,\n              enumerable: false,\n            });\n            this.#syntheticRows.set(node.key, placeholder);\n          }\n          this.#meta.set(placeholder, this.#syntheticMeta.get(node.key)!);\n          out.push(placeholder);\n        }\n      }\n      const expanded =\n        node === root ||\n        (node.data ? this.expanded.has(node.data) : this.expandedKeys.has(node.key));\n      if (expanded) {\n        for (const child of node.children) walk(child);\n      }\n    };\n    walk(root);\n    return out;\n  }\n\n  async #commit(mutate: (nextData: Set<T>, nextKeys: Set<string>) => void): Promise<boolean> {\n    const nextData = new Set(this.expanded);\n    const nextKeys = new Set(this.expandedKeys);\n    mutate(nextData, nextKeys);\n\n    const dataChanged =\n      nextData.size !== this.expanded.size || [...nextData].some((row) => !this.expanded.has(row));\n    const keysChanged =\n      nextKeys.size !== this.expandedKeys.size ||\n      [...nextKeys].some((key) => !this.expandedKeys.has(key));\n    if (!dataChanged && !keysChanged) return true;\n\n    const added: T[] = [];\n    const removed: T[] = [];\n    for (const row of nextData) if (!this.expanded.has(row)) added.push(row);\n    for (const row of this.expanded) if (!nextData.has(row)) removed.push(row);\n\n    const proceed = this.host.emitEvent('treeRowExpanding', {\n      detail: {\n        added,\n        removed,\n        current: Array.from(this.expanded),\n        next: Array.from(nextData),\n      },\n      cancelable: true,\n    });\n    if (!proceed) return false;\n\n    this.expanded = nextData;\n    this.expandedKeys = nextKeys;\n    // Re-run the pipeline so the flat output reflects the new expansion set.\n    this.host.requestUpdate(PIPELINE);\n\n    this.host.emitEvent('treeRowExpanded', {\n      detail: { added, removed, expanded: Array.from(this.expanded) },\n    });\n    return true;\n  }\n}\n"]}