apex-grid 3.4.0 → 3.6.0

package/controllers/selection.js

@@ -28,10 +28,14 @@ export class SelectionController {
         return Array.from(this.selected);
     }
     allSelected() {
-        const view = this.host.dataView;
-        if (view.length === 0)
+        const records = this.#records();
+        if (records.length === 0)
             return false;
-        return view.every((row) => this.selected.has(row));
+        for (const row of records) {
+            if (!this.selected.has(row))
+                return false;
+        }
+        return true;
     }
     someSelected() {
         if (this.selected.size === 0)
@@ -41,7 +45,7 @@ export class SelectionController {
         return true;
     }
     async toggleRow(row) {
-        if (!this.enabled)
+        if (!this.enabled || !this.#isDataRow(row))
             return false;
         const next = new Set(this.selected);
         if (next.has(row)) {
@@ -56,7 +60,7 @@ export class SelectionController {
         return this.#commit(next);
     }
     async selectRow(row) {
-        if (!this.enabled)
+        if (!this.enabled || !this.#isDataRow(row))
             return false;
         const next = new Set(this.mode === 'single' ? [] : this.selected);
         next.add(row);
@@ -73,7 +77,7 @@ export class SelectionController {
         return this.#commit(next);
     }
     async additiveToggle(row) {
-        if (!this.enabled)
+        if (!this.enabled || !this.#isDataRow(row))
             return false;
         if (this.mode === 'single')
             return this.toggleRow(row);
@@ -88,7 +92,7 @@ export class SelectionController {
         return this.#commit(next);
     }
     async rangeToggle(row) {
-        if (!this.enabled)
+        if (!this.enabled || !this.#isDataRow(row))
             return false;
         if (this.mode === 'single' || !this.anchor) {
             return this.selectRow(row);
@@ -102,15 +106,15 @@ export class SelectionController {
         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]);
+            if (this.#isDataRow(pageItems[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);
+        return this.#commit(new Set(this.#records()));
     }
     async clear() {
         if (this.selected.size === 0)
@@ -120,9 +124,20 @@ export class SelectionController {
     async replaceSelection(rows) {
         if (!this.enabled)
             return false;
-        const next = new Set(this.mode === 'single' ? rows.slice(0, 1) : rows);
+        const records = this.#state?.dataRows(rows) ?? rows;
+        const next = new Set(this.mode === 'single' ? records.slice(0, 1) : records);
         return this.#commit(next);
     }
+    get #state() {
+        return this.host.stateController;
+    }
+    #records() {
+        const view = this.host.dataView;
+        return this.#state?.viewRecords(view) ?? view;
+    }
+    #isDataRow(row) {
+        return this.#state?.isDataRow(row) ?? true;
+    }
     async #commit(next) {
         const added = [];
         const removed = [];

package/controllers/selection.js.map

@@ -1 +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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACtE,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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACpF,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(this.host.localize('announce.selectionCleared'));\n    } else if (added.length === 1 && removed.length === 0 && total === 1) {\n      this.host.announce(this.host.localize('announce.rowSelected'));\n    } else {\n      this.host.announce(this.host.localize('announce.rowsSelected', { count: total }));\n    }\n\n    this.host.emitEvent('rowSelected', {\n      detail: { added, removed, selected: Array.from(this.selected) },\n    });\n    return true;\n  }\n}\n"]}
+{"version":3,"file":"selection.js","sourceRoot":"","sources":["../../src/controllers/selection.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC,MAAM,CAAC;IACpD,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,UAA2B;IACjC,kBAAkB,EAAE,KAAK;CAC1B,CAAC,CAAC;AAoBH,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;IAQM,WAAW;QAChB,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAChC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QACvC,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBAAE,OAAO,KAAK,CAAC;QAC5C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,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,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzD,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,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzD,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,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzD,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,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QACzD,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,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAAE,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAOM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IAChD,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,OAAO,GAAG,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;QACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAGD,IAAI,MAAM;QACR,OAAQ,IAAI,CAAC,IAA4D,CAAC,eAAe,CAAC;IAC5F,CAAC;IAGD,QAAQ;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAA4B,CAAC;QACpD,OAAO,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IAChD,CAAC;IAED,UAAU,CAAC,GAAM;QACf,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;IAC7C,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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAAC,CAAC,CAAC;QACtE,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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACjE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QACpF,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';\nimport type { StateController } from './state.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 * Only data records are selectable: rows a feature module synthesizes into the\n * view (group headers, a grand-total row; see {@link StateController.isDataRow})\n * are skipped by every mutation and ignored by {@link allSelected}.\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 data record the current view covers is selected, including\n   * the leaves of collapsed groups (see {@link StateController.viewRecords}).\n   * `false` when the view covers none. Used by the header checkbox to render\n   * its \"all\" state.\n   */\n  public allSelected(): boolean {\n    const records = this.#records();\n    if (records.length === 0) return false;\n    for (const row of records) {\n      if (!this.selected.has(row)) return false;\n    }\n    return true;\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 || !this.#isDataRow(row)) 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 || !this.#isDataRow(row)) 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 || !this.#isDataRow(row)) 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 || !this.#isDataRow(row)) 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      if (this.#isDataRow(pageItems[i])) next.add(pageItems[i]);\n    }\n    return this.#commit(next);\n  }\n\n  /**\n   * Selects every data record the current view ({@link ApexGrid.dataView})\n   * covers, including the leaves of collapsed groups. No-op in `'single'`\n   * mode.\n   */\n  public async selectAll(): Promise<boolean> {\n    if (!this.enabled || this.mode === 'single') return false;\n    return this.#commit(new Set(this.#records()));\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 records = this.#state?.dataRows(rows) ?? rows;\n    const next = new Set(this.mode === 'single' ? records.slice(0, 1) : records);\n    return this.#commit(next);\n  }\n\n  /** The owning state controller; absent only while the grid is constructing. */\n  get #state(): StateController<T> | undefined {\n    return (this.host as unknown as { stateController?: StateController<T> }).stateController;\n  }\n\n  /** The data records the current view covers, collapsed group leaves included. */\n  #records(): ReadonlyArray<T> {\n    const view = this.host.dataView as ReadonlyArray<T>;\n    return this.#state?.viewRecords(view) ?? view;\n  }\n\n  #isDataRow(row: T): boolean {\n    return this.#state?.isDataRow(row) ?? true;\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(this.host.localize('announce.selectionCleared'));\n    } else if (added.length === 1 && removed.length === 0 && total === 1) {\n      this.host.announce(this.host.localize('announce.rowSelected'));\n    } else {\n      this.host.announce(this.host.localize('announce.rowsSelected', { count: total }));\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.d.ts

@@ -1,13 +1,33 @@
 import type { ReactiveController } from 'lit';
 import type { ColumnConfiguration, GridHost, Keys } from '../internal/types.js';
-import type { SortExpression, SortState } from '../operations/sort/types.js';
+import type { SortExpression, SortingDirection, SortState } from '../operations/sort/types.js';
 export declare class SortController<T extends object> implements ReactiveController {
     #private;
     protected host: GridHost<T>;
     constructor(host: GridHost<T>);
     state: SortState<T>;
     sortFromHeaderClick(column: ColumnConfiguration<T>, additive?: boolean): Promise<void>;
-    prepareExpression({ key, sort: options }: ColumnConfiguration<T>): SortExpression<T>;
+    /**
+     * The one path for a sort the user starts from the UI (header click, column
+     * menu): fires the cancelable `sorting` event, replaces the sort unless the
+     * gesture is additive in multi-sort mode, announces, then fires `sorted`.
+     * Without a `direction` the column steps to its next direction.
+     */
+    sortFromUI(column: ColumnConfiguration<T>, { direction, additive }?: {
+        direction?: SortingDirection;
+        additive?: boolean;
+    }): Promise<void>;
+    /**
+     * The expression a UI sort would apply. Always a fresh object: the stored
+     * entry is only replaced once the `sorting` event is not cancelled.
+     */
+    prepareExpression({ key, sort: options }: ColumnConfiguration<T>, direction?: SortingDirection): SortExpression<T>;
+    /**
+     * Whether the UI offers sorting on `column`: it declares `sort` and no
+     * manual row order is active (sorting and a manual order are mutually
+     * exclusive). The one rule for every sort affordance, built in or a module's.
+     */
+    isSortable(column: ColumnConfiguration<T>): boolean;
     reset(key?: Keys<T>): void;
     protected _sort(expressions: SortExpression<T> | SortExpression<T>[]): void;
     sort(expressions: SortExpression<T> | SortExpression<T>[]): void;

package/controllers/sort.js

@@ -14,23 +14,22 @@ export class SortController {
         return this.host.sortConfiguration.triState;
     }
     #resolveSortOptions(options) {
-        const expr = {
-            caseSensitive: false,
-            comparer: undefined,
-        };
-        if (!options || typeof options === 'boolean') {
-            return expr;
+        const expr = {};
+        if (options && typeof options === 'object') {
+            if (options.caseSensitive !== undefined)
+                expr.caseSensitive = options.caseSensitive;
+            if (options.comparer !== undefined)
+                expr.comparer = options.comparer;
         }
-        return Object.assign(expr, {
-            caseSensitive: options.caseSensitive,
-            comparer: options.comparer,
-        });
+        return expr;
     }
     #createDefaultExpression(key) {
         const options = this.host.getColumn(key)?.sort;
         return {
             key,
             direction: 'ascending',
+            caseSensitive: false,
+            comparer: undefined,
             ...this.#resolveSortOptions(options),
         };
     }
@@ -56,8 +55,11 @@ export class SortController {
             ? this.reset(expression.key)
             : this.state.set(expression.key, { ...expression });
     }
-    async sortFromHeaderClick(column, additive = false) {
-        const expression = this.prepareExpression(column);
+    sortFromHeaderClick(column, additive = false) {
+        return this.sortFromUI(column, { additive });
+    }
+    async sortFromUI(column, { direction, additive = false } = {}) {
+        const expression = this.prepareExpression(column, direction);
         if (!this.#emitSortingEvent(expression)) {
             return;
         }
@@ -66,7 +68,7 @@ export class SortController {
         }
         const beforeRects = this.#captureRowRects();
         this._sort(expression);
-        await this.host.updateComplete;
+        await this.host.pipelineSettled();
         await awaitChildUpdates(this.host.rows);
         this.#playRowFlip(beforeRects);
         this.#announce(expression, column);
@@ -97,15 +99,16 @@ export class SortController {
         }
         playKeyedFlip(before, (data) => byData.get(data) ?? null, 'y');
     }
-    prepareExpression({ key, sort: options }) {
-        if (this.state.has(key)) {
-            const expr = this.state.get(key);
-            return Object.assign(expr, {
-                direction: this.#orderBy(expr.direction),
-                ...this.#resolveSortOptions(options),
-            });
-        }
-        return this.#createDefaultExpression(key);
+    prepareExpression({ key, sort: options }, direction) {
+        const expr = this.state.get(key);
+        return {
+            ...(expr ?? this.#createDefaultExpression(key)),
+            direction: direction ?? this.#orderBy(expr?.direction),
+            ...this.#resolveSortOptions(options),
+        };
+    }
+    isSortable(column) {
+        return Boolean(column.sort) && !this.#rowReorder?.hasManualOrder;
     }
     reset(key) {
         key ? this.state.delete(key) : this.state.clear();
@@ -125,7 +128,10 @@ export class SortController {
         this.host.requestUpdate(PIPELINE);
     }
     sort(expressions) {
-        this._sort(asArray(expressions).map((expr) => Object.assign(this.state.get(expr.key) ?? this.#createDefaultExpression(expr.key), expr)));
+        this._sort(asArray(expressions).map((expr) => ({
+            ...(this.state.get(expr.key) ?? this.#createDefaultExpression(expr.key)),
+            ...expr,
+        })));
     }
     hostConnected() { }
 }

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;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,EAAE,QAAQ,GAAG,KAAK;QAC/E,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;QAQD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvC,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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC;YACvD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAChB,UAAU,CAAC,SAAS,KAAK,WAAW;gBAClC,CAAC,CAAC,0BAA0B;gBAC5B,CAAC,CAAC,2BAA2B,EAC/B,EAAE,KAAK,EAAE,CACV,CAAC;QACR,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;IAED,IAAI,WAAW;QAEb,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAEpB,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,WAAoD;QAClE,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QAGnC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QACjC,IAAI,OAAO,EAAE,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,EAAE,CAAC;YAC/E,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,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>, additive = false) {\n    const expression = this.prepareExpression(column);\n\n    if (!this.#emitSortingEvent(expression)) {\n      return;\n    }\n\n    // A plain click sorts by this column alone, clearing any other sorted\n    // columns. Only a Ctrl/Cmd+click while multi-sort is enabled keeps the\n    // existing sort keys and appends this column as an additional, lower-\n    // priority sort. Without this gate every plain click would accumulate a\n    // key, so a second column added behind a unique primary column would not\n    // change the visible order at all.\n    if (!this.#isMultipleSort || !additive) {\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        ? this.host.localize('announce.sortCleared', { label })\n        : this.host.localize(\n            expression.direction === 'ascending'\n              ? 'announce.sortedAscending'\n              : 'announce.sortedDescending',\n            { label }\n          );\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  get #rowReorder() {\n    // @ts-expect-error - protected member access\n    return this.host.stateController.rowReorder as\n      | { hasManualOrder: boolean; clearManualOrder(announce?: boolean): void }\n      | undefined;\n  }\n\n  protected _sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    const exprs = asArray(expressions);\n    // Applying a sort is mutually exclusive with a manual row order (F5):\n    // a real sort (any non-`none` direction) clears it, with an announcement.\n    const reorder = this.#rowReorder;\n    if (reorder?.hasManualOrder && exprs.some((expr) => expr.direction !== 'none')) {\n      reorder.clearManualOrder(true);\n    }\n\n    for (const expr of exprs) {\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;IASD,mBAAmB,CAAC,OAA8C;QAChE,MAAM,IAAI,GAA+B,EAAE,CAAC;QAC5C,IAAI,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC3C,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;gBAAE,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;YACpF,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS;gBAAE,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAe,CAAC;QAC9E,CAAC;QACD,OAAO,IAAI,CAAC;IACd,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,aAAa,EAAE,KAAK;YACpB,QAAQ,EAAE,SAAS;YACnB,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,mBAAmB,CAAC,MAA8B,EAAE,QAAQ,GAAG,KAAK;QACzE,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC;IAQM,KAAK,CAAC,UAAU,CACrB,MAA8B,EAC9B,EAAE,SAAS,EAAE,QAAQ,GAAG,KAAK,KAA2D,EAAE;QAE1F,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAE7D,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,OAAO;QACT,CAAC;QAQD,IAAI,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;QAMD,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAE5C,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAGvB,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;QAIlC,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,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC;YACvD,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAChB,UAAU,CAAC,SAAS,KAAK,WAAW;gBAClC,CAAC,CAAC,0BAA0B;gBAC5B,CAAC,CAAC,2BAA2B,EAC/B,EAAE,KAAK,EAAE,CACV,CAAC;QACR,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;IAMM,iBAAiB,CACtB,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAA0B,EAC9C,SAA4B;QAE5B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjC,OAAO;YACL,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YAC/C,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;YACtD,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;SAChB,CAAC;IACzB,CAAC;IAOM,UAAU,CAAC,MAA8B;QAC9C,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC;IACnE,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;IAED,IAAI,WAAW;QAEb,OAAO,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAEpB,CAAC;IAChB,CAAC;IAES,KAAK,CAAC,WAAoD;QAClE,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;QAGnC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QACjC,IAAI,OAAO,EAAE,cAAc,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,MAAM,CAAC,EAAE,CAAC;YAC/E,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,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,CACtB,CAAC,IAAI,EAAE,EAAE,CACP,CAAC;YACC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxE,GAAG,IAAI;SACR,CAAsB,CAC1B,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  /**\n   * Only the options the column config actually sets, so a header click keeps a\n   * comparer or caseSensitive that came in through `grid.sort()` when the column\n   * itself does not define one. The trade-off: a comparer later removed from\n   * the column config stays on the stored expression until that column's sort\n   * is cleared, because its origin is not tracked.\n   */\n  #resolveSortOptions(options?: boolean | ColumnSortConfiguration<T>) {\n    const expr: Partial<SortExpression<T>> = {};\n    if (options && typeof options === 'object') {\n      if (options.caseSensitive !== undefined) expr.caseSensitive = options.caseSensitive;\n      if (options.comparer !== undefined) expr.comparer = options.comparer as any;\n    }\n    return expr;\n  }\n\n  #createDefaultExpression(key: Keys<T>) {\n    const options = this.host.getColumn(key)?.sort;\n\n    return {\n      key,\n      direction: 'ascending',\n      caseSensitive: false,\n      comparer: undefined,\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 sortFromHeaderClick(column: ColumnConfiguration<T>, additive = false) {\n    return this.sortFromUI(column, { additive });\n  }\n\n  /**\n   * The one path for a sort the user starts from the UI (header click, column\n   * menu): fires the cancelable `sorting` event, replaces the sort unless the\n   * gesture is additive in multi-sort mode, announces, then fires `sorted`.\n   * Without a `direction` the column steps to its next direction.\n   */\n  public async sortFromUI(\n    column: ColumnConfiguration<T>,\n    { direction, additive = false }: { direction?: SortingDirection; additive?: boolean } = {}\n  ) {\n    const expression = this.prepareExpression(column, direction);\n\n    if (!this.#emitSortingEvent(expression)) {\n      return;\n    }\n\n    // A plain click sorts by this column alone, clearing any other sorted\n    // columns. Only a Ctrl/Cmd+click while multi-sort is enabled keeps the\n    // existing sort keys and appends this column as an additional, lower-\n    // priority sort. Without this gate every plain click would accumulate a\n    // key, so a second column added behind a unique primary column would not\n    // change the visible order at all.\n    if (!this.#isMultipleSort || !additive) {\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    // @ts-expect-error - protected member access\n    await this.host.pipelineSettled();\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        ? this.host.localize('announce.sortCleared', { label })\n        : this.host.localize(\n            expression.direction === 'ascending'\n              ? 'announce.sortedAscending'\n              : 'announce.sortedDescending',\n            { label }\n          );\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  /**\n   * The expression a UI sort would apply. Always a fresh object: the stored\n   * entry is only replaced once the `sorting` event is not cancelled.\n   */\n  public prepareExpression(\n    { key, sort: options }: ColumnConfiguration<T>,\n    direction?: SortingDirection\n  ): SortExpression<T> {\n    const expr = this.state.get(key);\n\n    return {\n      ...(expr ?? this.#createDefaultExpression(key)),\n      direction: direction ?? this.#orderBy(expr?.direction),\n      ...this.#resolveSortOptions(options),\n    } as SortExpression<T>;\n  }\n\n  /**\n   * Whether the UI offers sorting on `column`: it declares `sort` and no\n   * manual row order is active (sorting and a manual order are mutually\n   * exclusive). The one rule for every sort affordance, built in or a module's.\n   */\n  public isSortable(column: ColumnConfiguration<T>): boolean {\n    return Boolean(column.sort) && !this.#rowReorder?.hasManualOrder;\n  }\n\n  public reset(key?: Keys<T>) {\n    key ? this.state.delete(key) : this.state.clear();\n  }\n\n  get #rowReorder() {\n    // @ts-expect-error - protected member access\n    return this.host.stateController.rowReorder as\n      | { hasManualOrder: boolean; clearManualOrder(announce?: boolean): void }\n      | undefined;\n  }\n\n  protected _sort(expressions: SortExpression<T> | SortExpression<T>[]) {\n    const exprs = asArray(expressions);\n    // Applying a sort is mutually exclusive with a manual row order (F5):\n    // a real sort (any non-`none` direction) clears it, with an announcement.\n    const reorder = this.#rowReorder;\n    if (reorder?.hasManualOrder && exprs.some((expr) => expr.direction !== 'none')) {\n      reorder.clearManualOrder(true);\n    }\n\n    for (const expr of exprs) {\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(\n        (expr) =>\n          ({\n            ...(this.state.get(expr.key) ?? this.#createDefaultExpression(expr.key)),\n            ...expr,\n          }) as SortExpression<T>\n      )\n    );\n  }\n\n  public hostConnected() {}\n}\n"]}

package/controllers/state.d.ts

@@ -1,7 +1,7 @@
 import type { ReactiveController } from 'lit';
 import type { GridLocaleKey, LocaleParams } from '../i18n/index.js';
-import { type CellDecoration, type CellDecoratorContext, type CellInteraction, type GridFeatureModule, type PresentedRow, type RowPresenterContext } from '../internal/feature-module.js';
-import type { ActiveNode, GridHost } from '../internal/types.js';
+import { type CellDecoration, type CellDecoratorContext, type CellInteraction, type GridFeatureModule, type PresentedRow, type RowAria, type RowPresenterContext } from '../internal/feature-module.js';
+import type { ActiveNode, ColumnConfiguration, GridHost } from '../internal/types.js';
 import { EditingController } from './editing.js';
 import { ExpansionController } from './expansion.js';
 import { FilterController } from './filter.js';
@@ -57,12 +57,19 @@ export declare class StateController<T extends object> implements ReactiveContro
      * {@link ApexGrid.localize} so components can localize via `this.state`.
      */
     localize(key: GridLocaleKey, params?: LocaleParams, fallback?: string): string;
+    /**
+     * Whether `column` holds numbers (`'number'`, `'currency'`, `'rating'`,
+     * `'progress'`), so it filters with the number operands and a numeric term.
+     * The one numeric-type rule the core filter applies; features that classify
+     * columns should read it here rather than keep their own list.
+     */
+    isNumericColumn(column: Pick<ColumnConfiguration<T>, 'type'>): boolean;
     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;
-    get paginator(): import("../components/paginator.js").default<T>;
-    get toolbar(): import("../components/toolbar.js").default<T>;
+    get paginator(): import("../index.js").ApexGridPaginator<T>;
+    get toolbar(): import("../index.js").ApexGridToolbar<T>;
     /**
      * Cumulative pin offsets (in px) keyed by column key. Populated by the
      * {@link GridDOMController} after each layout.
@@ -77,18 +84,64 @@ export declare class StateController<T extends object> implements ReactiveContro
     module<C extends ReactiveController>(id: string): C | undefined;
     /**
      * Runs the post-pipeline row transforms contributed by feature modules
-     * implementing {@link RowTransformer}, in registration order. Returns the
-     * input unchanged when no such module is registered — the community grid path
-     * is a no-op pass-through.
+     * implementing {@link RowTransformer}, in ascending
+     * {@link RowTransformer.transformOrder} (registration order breaks ties).
+     * Returns the input unchanged when no such module is registered, so the
+     * community grid path is a no-op pass-through.
      */
     applyModuleTransforms(rows: T[]): T[];
+    /**
+     * Whether `row` is a data record, as opposed to a row a feature module
+     * synthesized into the view (a group header, a grand-total row). Every
+     * consumer that treats the view as records (selection, export, paste, charts,
+     * keyboard actions) should skip rows for which this is `false`. A row is
+     * synthetic when any {@link RowTransformer} claims it through
+     * {@link RowTransformer.isSyntheticRow}. Always `true` for the community grid,
+     * which registers no modules, at the cost of one length check.
+     */
+    isDataRow(row: T): boolean;
+    /**
+     * The data records of `rows` (see {@link isDataRow}), in order. Returns `rows`
+     * itself, not a copy, when no module synthesizes rows (the community grid).
+     */
+    dataRows(rows: ReadonlyArray<T>): ReadonlyArray<T>;
+    /**
+     * Every data record `rows` (a view) covers, in order: its data rows plus the
+     * records a synthesized row hides through
+     * {@link RowTransformer.hiddenRecords} (a collapsed group's leaves). This is
+     * what Select all selects and a `'view'` export writes. Returns `rows`
+     * itself when no module synthesizes rows (the community grid).
+     */
+    viewRecords(rows: ReadonlyArray<T>): ReadonlyArray<T>;
     /**
      * Asks feature modules implementing {@link RowPresenter} whether they render
      * the given row as full-width custom content (e.g. a group header). Returns
      * the first non-null result, or `null` when no module owns the row.
      */
     presentRow(row: T, ctx: RowPresenterContext<T>): PresentedRow | null;
+    /**
+     * Asks feature modules implementing {@link RowAriaProvider} for ARIA
+     * tree/expansion semantics on a normal (cell-rendered) row — e.g. pivoting's
+     * expandable parent rows. Returns the first non-null result, or `null`.
+     */
+    describeRow(row: T, ctx: RowPresenterContext<T>): RowAria | null;
+    /**
+     * The coordinate-hint label a module gives a row ({@link CoordinateLabeler}),
+     * `null` for none, or `undefined` when no module labels rows (the gutter then
+     * shows the view position). Only asked while `coordinateHints` is on.
+     */
+    rowCoordinate(row: T): string | null | undefined;
+    /** The coordinate-hint letter a module gives a column; see {@link rowCoordinate}. */
+    columnCoordinate(key: string): string | null | undefined;
     get decorationVersion(): number;
+    /**
+     * Monotonic token the grid bumps once per data pipeline run, forwarded to
+     * each body row and cell, so a cell whose output reads more than its own
+     * value (a `cellTemplate` reading other row fields, the tree group cell's
+     * chevron) re-renders after an edit, a data change or a tree toggle,
+     * although its own value binding did not change.
+     */
+    dataVersion: number;
     /**
      * Signals that {@link CellDecorator} output may have changed. Bumps the
      * {@link decorationVersion} and requests a host update so cells re-run their
@@ -124,10 +177,12 @@ export declare class StateController<T extends object> implements ReactiveContro
     serializeModuleState(): Record<string, unknown>;
     /**
      * Dispatches previously-serialized state back to the matching feature modules
-     * (by id) that implement {@link SerializableModule}. Missing ids and unknown
-     * modules are ignored. Used by `ApexGrid.setState`.
+     * (by id) that implement {@link SerializableModule}, in registration order.
+     * Returns the ids in `data` that no registered module consumed, so the caller
+     * can report them instead of counting them as applied. Used by
+     * `ApexGrid.setState`.
      */
-    restoreModuleState(data: Record<string, unknown> | undefined): void;
+    restoreModuleState(data: Record<string, unknown> | undefined): string[];
     hostConnected(): void;
     hostUpdate(): void;
 }

package/controllers/state.js

@@ -1,5 +1,6 @@
 import { createContext } from '@lit/context';
-import { isCellDecorator, isCellInteractionHandler, isColumnMenuProvider, isRowPresenter, isRowTransformer, isSerializableModule, } from '../internal/feature-module.js';
+import { isCellDecorator, isCellInteractionHandler, isColumnMenuProvider, isCoordinateLabeler, isRowAriaProvider, isRowPresenter, isRowTransformer, isSerializableModule, } from '../internal/feature-module.js';
+import { isNumericColumn } from '../internal/utils.js';
 import { EditingController } from './editing.js';
 import { ExpansionController } from './expansion.js';
 import { FilterController } from './filter.js';
@@ -28,6 +29,9 @@ export class StateController {
     localize(key, params, fallback) {
         return this.host.localize(key, params, fallback);
     }
+    isNumericColumn(column) {
+        return isNumericColumn(column);
+    }
     get active() {
         return this.navigation.active;
     }
@@ -56,7 +60,10 @@ export class StateController {
         this.modules = new Map();
         this.announcement = '';
         this.#announceToken = 0;
+        this.#transformers = [];
+        this.#synthesizers = [];
         this.#decorationVersion = 0;
+        this.dataVersion = 0;
         this.host.addController(this);
         this.init();
     }
@@ -79,19 +86,61 @@ export class StateController {
                 continue;
             this.modules.set(module.id, module.create(this.host, this));
         }
+        if (this.modules.size) {
+            const transformers = [];
+            for (const controller of this.modules.values()) {
+                if (isRowTransformer(controller))
+                    transformers.push(controller);
+            }
+            transformers.sort((a, b) => (a.transformOrder ?? 0) - (b.transformOrder ?? 0));
+            this.#transformers = transformers;
+            this.#synthesizers = transformers.filter((t) => typeof t.isSyntheticRow === 'function');
+        }
     }
+    #transformers;
+    #synthesizers;
     module(id) {
         return this.modules.get(id);
     }
     applyModuleTransforms(rows) {
         let result = rows;
-        for (const controller of this.modules.values()) {
-            if (isRowTransformer(controller)) {
-                result = controller.processRows(result);
-            }
+        for (const transformer of this.#transformers) {
+            result = transformer.processRows(result);
         }
         return result;
     }
+    isDataRow(row) {
+        for (const transformer of this.#synthesizers) {
+            if (transformer.isSyntheticRow(row))
+                return false;
+        }
+        return true;
+    }
+    dataRows(rows) {
+        if (this.#synthesizers.length === 0)
+            return rows;
+        return rows.filter((row) => this.isDataRow(row));
+    }
+    viewRecords(rows) {
+        if (this.#synthesizers.length === 0)
+            return rows;
+        const out = [];
+        for (const row of rows) {
+            if (this.isDataRow(row)) {
+                out.push(row);
+                continue;
+            }
+            for (const transformer of this.#synthesizers) {
+                const hidden = transformer.hiddenRecords?.(row);
+                if (!hidden?.length)
+                    continue;
+                for (const record of hidden)
+                    out.push(record);
+                break;
+            }
+        }
+        return out;
+    }
     presentRow(row, ctx) {
         for (const controller of this.modules.values()) {
             if (isRowPresenter(controller)) {
@@ -102,6 +151,36 @@ export class StateController {
         }
         return null;
     }
+    describeRow(row, ctx) {
+        for (const controller of this.modules.values()) {
+            if (isRowAriaProvider(controller)) {
+                const aria = controller.describeRow(row, ctx);
+                if (aria)
+                    return aria;
+            }
+        }
+        return null;
+    }
+    rowCoordinate(row) {
+        for (const controller of this.modules.values()) {
+            if (isCoordinateLabeler(controller)) {
+                const label = controller.rowCoordinate(row);
+                if (label !== undefined)
+                    return label;
+            }
+        }
+        return undefined;
+    }
+    columnCoordinate(key) {
+        for (const controller of this.modules.values()) {
+            if (isCoordinateLabeler(controller)) {
+                const label = controller.columnCoordinate(key);
+                if (label !== undefined)
+                    return label;
+            }
+        }
+        return undefined;
+    }
     #decorationVersion;
     get decorationVersion() {
         return this.#decorationVersion;
@@ -149,12 +228,13 @@ export class StateController {
     }
     restoreModuleState(data) {
         if (!data)
-            return;
+            return [];
         for (const [id, controller] of this.modules) {
             if (isSerializableModule(controller) && Object.hasOwn(data, id)) {
                 controller.restoreState(data[id]);
             }
         }
+        return Object.keys(data).filter((id) => !isSerializableModule(this.modules.get(id)));
     }
     hostConnected() { }
     hostUpdate() {