@svgrid/grid 2.6.1 → 2.6.3

package/src/menus.ts

@@ -1,567 +1,567 @@
-// menus handlers extracted from the controller. Imperative event handlers
-// reading/writing controller state via the `ctx` handle; the reactive core
-// ($state/$derived/$effect) stays in the controller.
-import {
-  type RowData,
-  type TableFeatures,
-} from "./index";
-import "./sv-grid-scrollbar";
-import { untrack } from "svelte";
-import type {
-  FilterOperator,
-} from "./SvGrid.types";
-import {
-  clampMenuX,
-  cssEscape,
-} from "./SvGrid.helpers";
-import { splitInTokens, joinInTokens } from "./filtering/excel-filters";
-
-export function createMenus<
-  TFeatures extends TableFeatures = TableFeatures,
-  TData extends RowData = RowData,
->(ctx: any) {
-  function updateFilterRow(columnId: string, value: string) {
-    ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
-    const current = ctx.filterMenuValues[columnId] ?? {
-      operator: "contains" as const,
-      value: "",
-    };
-    ctx.filterMenuValues = {
-      ...ctx.filterMenuValues,
-      [columnId]: { ...current, value },
-    };
-  }
-
-  function updateFilterOperator(columnId: string, operator: FilterOperator) {
-    const current = ctx.filterMenuValues[columnId] ?? {
-      operator: "contains" as const,
-      value: "",
-    };
-    ctx.filterMenuValues = {
-      ...ctx.filterMenuValues,
-      [columnId]: { ...current, operator },
-    };
-  }
-
-  function updateFilterMenuValue(columnId: string, value: string) {
-    const current = ctx.filterMenuValues[columnId] ?? {
-      operator: "contains" as const,
-      value: "",
-    };
-    ctx.filterMenuValues = {
-      ...ctx.filterMenuValues,
-      [columnId]: { ...current, value },
-    };
-    ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
-  }
-
-  /** Upper-bound input for the `between` operator. Only relevant when
-   *  the column's current operator is `between`; harmless to call
-   *  otherwise. */
-  function updateFilterMenuValueTo(columnId: string, valueTo: string) {
-    const current = ctx.filterMenuValues[columnId] ?? {
-      operator: "between" as const,
-      value: "",
-    };
-    ctx.filterMenuValues = {
-      ...ctx.filterMenuValues,
-      [columnId]: { ...current, valueTo },
-    };
-  }
-
-  /** Current `in` / `notIn` token list for a column (from the filter-row value). */
-  function filterTokens(columnId: string): string[] {
-    return splitInTokens(ctx.filterRowValues[columnId] ?? "");
-  }
-
-  /** Add a value to a column's `in` / `notIn` list (no-op if already present). */
-  function addFilterToken(columnId: string, token: string) {
-    const t = token.trim();
-    if (!t) return;
-    const tokens = filterTokens(columnId);
-    if (!tokens.includes(t)) tokens.push(t);
-    updateFilterRow(columnId, joinInTokens(tokens));
-  }
-
-  /** Remove a value from a column's `in` / `notIn` list. */
-  function removeFilterToken(columnId: string, token: string) {
-    updateFilterRow(
-      columnId,
-      joinInTokens(filterTokens(columnId).filter((t) => t !== token)),
-    );
-  }
-
-  /** Toggle a value in a column's `in` / `notIn` list (checklist behaviour). */
-  function toggleFilterToken(columnId: string, token: string) {
-    if (filterTokens(columnId).includes(token)) removeFilterToken(columnId, token);
-    else addFilterToken(columnId, token);
-  }
-
-  /**
-   * Replace a column's `in` / `notIn` list wholesale. The suggestions dropdown
-   * hands back the full token set after a click, which keeps tokens the user
-   * typed by hand (or that the search box is currently hiding) intact.
-   */
-  function setFilterTokens(columnId: string, tokens: Iterable<string>) {
-    const list = [...tokens].map((t) => t.trim()).filter(Boolean);
-    updateFilterRow(columnId, joinInTokens(list));
-  }
-
-  function toggleCheckboxWithKeyboard(
-    event: KeyboardEvent,
-    toggle: () => void,
-  ) {
-    if (event.key !== "Enter" && event.key !== " ") return;
-    event.preventDefault();
-    toggle();
-  }
-
-  function isColumnFiltered(columnId: string) {
-    if (ctx.valueFilters[columnId]) return true;
-    const menuFilter = ctx.filterMenuValues[columnId];
-    return Boolean(
-      menuFilter &&
-        (menuFilter.operator === "isBlank" ||
-          menuFilter.operator === "isNotBlank" ||
-          menuFilter.value.trim()),
-    );
-  }
-
-  function closeMenus() {
-    ctx.columnMenuFor = null;
-    ctx.filterMenuFor = null;
-    ctx.operatorMenuFor = null;
-    ctx.inSuggestFor = null;
-    ctx.chooseColumnsPos = null;
-  }
-
-  /** Open the `in` / `notIn` value-suggestions dropdown under a chip input. */
-  function openInSuggest(anchor: HTMLElement, columnId: string) {
-    const rect = anchor.getBoundingClientRect();
-    ctx.inSuggestPos = { x: clampMenuX(rect.left, 220), y: rect.bottom + 4 };
-    ctx.inSuggestQuery = "";
-    ctx.inSuggestFor = columnId;
-  }
-
-  function closeInSuggest() {
-    ctx.inSuggestFor = null;
-    ctx.inSuggestQuery = "";
-  }
-
-  function openChooseColumns(event: MouseEvent) {
-    event.stopPropagation();
-    // Submenu behavior: keep the parent operations menu open and float the
-    // Choose Columns panel out to the right of it (AG-Grid style). Falls
-    // back to below the item if the popover would clip the viewport.
-    const trigger = event.currentTarget as HTMLElement;
-    const menuEl = trigger.closest(".sv-grid-menu") as HTMLElement | null;
-    const anchor = (menuEl ?? trigger).getBoundingClientRect();
-    const panelWidth = 240;
-    const wantRight = anchor.right + 4;
-    const x =
-      wantRight + panelWidth + 8 > window.innerWidth
-        ? clampMenuX(anchor.left - panelWidth - 4, panelWidth)
-        : clampMenuX(wantRight, panelWidth);
-    ctx.chooseColumnsPos = { x, y: anchor.top };
-  }
-
-  function openColumnMenu(event: MouseEvent, columnId: string) {
-    event.stopPropagation();
-    const wasOpen = ctx.columnMenuFor === columnId;
-    closeMenus();
-    if (wasOpen) return;
-    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
-    ctx.columnMenuPos = {
-      x: clampMenuX(rect.right - 240, 240),
-      y: rect.bottom + 4,
-    };
-    ctx.columnMenuTab = "general";
-    ctx.columnMenuFor = columnId;
-  }
-
-  function openFilterMenu(event: MouseEvent, columnId: string) {
-    event.stopPropagation();
-    const wasOpen = ctx.filterMenuFor === columnId;
-    closeMenus();
-    if (wasOpen) return;
-
-    // If the consumer is running in row-mode (or any mode where the
-    // funnel popover wouldn't render), redirect the click to the
-    // inline filter input for this column. Without this the funnel
-    // would be a dead button - it visibly clicks but nothing happens
-    // because the menu is gated behind `showColumnFiltersEffective`.
-    if (!ctx.showColumnFiltersEffective && ctx.showFilterRowEffective) {
-      // Find the row-mode filter input and focus it. The input is
-      // tagged with `data-svgrid-filter-col` so we can target by id
-      // without depending on column position.
-      const input = (ctx.scrollContainer as HTMLElement | null)?.querySelector<HTMLInputElement>(
-        `[data-svgrid-filter-col="${cssEscape(columnId)}"]`,
-      );
-      if (input) {
-        input.focus();
-        input.select();
-        // Brief pulse so the user sees where focus landed.
-        input.classList.add("sv-grid-filter-value-pulse");
-        setTimeout(() => input.classList.remove("sv-grid-filter-value-pulse"), 700);
-      }
-      return;
-    }
-
-    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
-    ctx.filterMenuPos = {
-      x: clampMenuX(rect.right - 260, 260),
-      y: rect.bottom + 4,
-    };
-    ctx.columnMenuSearch = "";
-    ctx.filterMenuFor = columnId;
-  }
-
-  function openOperatorMenu(event: MouseEvent, columnId: string) {
-    event.stopPropagation();
-    const wasOpen = ctx.operatorMenuFor === columnId;
-    closeMenus();
-    if (wasOpen) return;
-    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
-    ctx.operatorMenuPos = { x: clampMenuX(rect.left, 184), y: rect.bottom + 4 };
-    ctx.operatorMenuFor = columnId;
-  }
-
-  function sortColumnFromMenu(columnId: string, desc: boolean) {
-    ctx.grid.store.setState((prev: any) => ({
-      ...prev,
-      sorting: [{ id: columnId, desc }],
-    }));
-    closeMenus();
-  }
-
-  function clearColumnSort(columnId: string) {
-    ctx.grid.store.setState((prev: any) => ({
-      ...prev,
-      sorting: (prev.sorting ?? []).filter(
-        (entry: { id: string }) => entry.id !== columnId,
-      ),
-    }));
-    closeMenus();
-  }
-
-  function groupByColumnFromMenu(columnId: string) {
-    const current = ctx.grid.getState().grouping ?? [];
-    if (current.includes(columnId)) {
-      closeMenus();
-      return;
-    }
-    ctx.grid.setGrouping([...current, columnId]);
-    closeMenus();
-  }
-
-  function clearGroupingFromMenu(columnId: string) {
-    const current = ctx.grid.getState().grouping ?? [];
-    ctx.grid.setGrouping(current.filter((id: string) => id !== columnId));
-    closeMenus();
-  }
-
-  function isFacetChecked(columnId: string, value: string) {
-    const selected = ctx.valueFilters[columnId];
-    return selected ? selected.has(value) : true;
-  }
-
-  function toggleFacetValue(columnId: string, value: string) {
-    const allValues = ctx.columnMenuFacetValues;
-    const next = new Set(ctx.valueFilters[columnId] ?? allValues);
-    if (next.has(value)) next.delete(value);
-    else next.add(value);
-    if (next.size === allValues.length) {
-      const copy = { ...ctx.valueFilters };
-      delete copy[columnId];
-      ctx.valueFilters = copy;
-    } else {
-      ctx.valueFilters = { ...ctx.valueFilters, [columnId]: next };
-    }
-  }
-
-  /**
-   * Replace a column's checked-facet set. "Everything checked" is stored as an
-   * ABSENT entry (so an unfiltered high-cardinality column never holds a set of
-   * every value), which is why the full-size case deletes instead of writing.
-   */
-  function setFacetSelection(columnId: string, next: ReadonlySet<string>) {
-    if (next.size >= ctx.columnMenuFacetValues.length) {
-      const copy = { ...ctx.valueFilters };
-      delete copy[columnId];
-      ctx.valueFilters = copy;
-      return;
-    }
-    ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set(next) };
-  }
-
-  function isAllFacetsChecked(columnId: string) {
-    const selected = ctx.valueFilters[columnId];
-    return !selected || selected.size >= ctx.columnMenuFacetValues.length;
-  }
-
-  function toggleAllFacets(columnId: string) {
-    if (isAllFacetsChecked(columnId)) {
-      ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set<string>() };
-    } else {
-      const copy = { ...ctx.valueFilters };
-      delete copy[columnId];
-      ctx.valueFilters = copy;
-    }
-  }
-
-  function clearColumnFilter(columnId: string) {
-    // `untrack`: read-modify-write on the filter maps. Keeps the method safe to
-    // call from a consumer's reactive `$effect` (e.g. via `api.clearFilter`)
-    // without capturing these reads as a dependency and looping. See
-    // `build-api`'s `setFilter` for the full rationale.
-    untrack(() => {
-      if (ctx.valueFilters[columnId]) {
-        const next = { ...ctx.valueFilters };
-        delete next[columnId];
-        ctx.valueFilters = next;
-      }
-      if (ctx.filterMenuValues[columnId]) {
-        const next = { ...ctx.filterMenuValues };
-        delete next[columnId];
-        ctx.filterMenuValues = next;
-      }
-      if (ctx.filterRowValues[columnId]) {
-        const next = { ...ctx.filterRowValues };
-        delete next[columnId];
-        ctx.filterRowValues = next;
-      }
-    });
-  }
-
-  // External pagination is controlled: emit the requested page/size and let
-  // the consumer fetch + update props. Never mutate local pagination state.
-  function emitExternalPagination(pageIndex: number, pageSize: number): boolean {
-    if (ctx.props.externalPagination !== true) return false;
-    ctx.props.onPaginationChange?.({ pageIndex: Math.max(0, pageIndex), pageSize });
-    ctx.scrollContainer?.scrollTo?.({ top: 0 });
-    return true;
-  }
-
-  function changePage(delta: number) {
-    if (
-      emitExternalPagination(
-        (ctx.props.pageIndex ?? 0) + delta,
-        ctx.props.pageSize ?? 10,
-      )
-    )
-      return;
-    ctx.grid.setPagination((prev: any) => ({
-      ...prev,
-      pageIndex: Math.max((prev?.pageIndex ?? 0) + delta, 0),
-    }));
-    ctx.scrollContainer?.scrollTo?.({ top: 0 });
-  }
-
-  function goToPage(pageIndex: number) {
-    if (emitExternalPagination(pageIndex, ctx.props.pageSize ?? 10)) return;
-    ctx.grid.setPagination((prev: any) => ({
-      ...prev,
-      pageIndex: Math.max(0, pageIndex),
-    }));
-    ctx.scrollContainer?.scrollTo?.({ top: 0 });
-  }
-
-  function setPageSize(pageSize: number) {
-    // External mode: changing page size resets to the first page.
-    if (emitExternalPagination(0, pageSize)) return;
-    ctx.grid.setPagination((prev: any) => {
-      const oldSize = prev?.pageSize ?? 10;
-      const oldIndex = prev?.pageIndex ?? 0;
-      // Keep the first visible row in view when the page size changes.
-      const firstVisibleRow = oldIndex * oldSize;
-      return {
-        ...prev,
-        pageSize,
-        pageIndex: Math.max(0, Math.floor(firstVisibleRow / pageSize)),
-      };
-    });
-  }
-
-  // ---- Right-click context menu --------------------------------------
-  type CtxTarget = { rowIndex: number; colIndex: number; columnId: string; rowId: string; row: TData | null };
-  type ResolvedItem = { key: string; label: string; separator?: boolean; disabled?: boolean; run?: () => void };
-
-  function insertRowAt(t: CtxTarget, offset: number) {
-    const data = ctx.internalData.slice() as TData[];
-    const idx = t.row ? data.indexOf(t.row) : -1;
-    const at = idx < 0 ? data.length : idx + offset;
-    data.splice(at, 0, {} as TData);
-    ctx.internalData = data;
-  }
-  function removeRowAt(t: CtxTarget) {
-    if (!t.row) return;
-    ctx.internalData = (ctx.internalData as TData[]).filter((r) => r !== t.row);
-  }
-  function removeColAt(t: CtxTarget) {
-    ctx.internalColumns = ctx.internalColumns.filter(
-      (d: any) => (d.id ?? d.field) !== t.columnId,
-    );
-  }
-
-  // Built-in items, keyed. `run` reads the live target passed at click time.
-  // `msg` names the GridMessages key so the label localizes (falls back to the
-  // English `label` when no `localeText` is set).
-  const builtins: Record<string, { label: string; msg?: string; run: (t: CtxTarget) => void }> = {
-    copy: { label: "Copy", msg: "menuCopy", run: () => ctx.copySelectionToClipboard() },
-    cut: { label: "Cut", msg: "menuCut", run: () => ctx.cutSelectionToClipboard() },
-    paste: { label: "Paste", msg: "menuPaste", run: () => void ctx.pasteFromClipboard() },
-    clear: { label: "Clear", msg: "menuClear", run: () => ctx.clearSelectedCells() },
-    row_above: { label: "Insert row above", msg: "menuInsertRowAbove", run: (t) => insertRowAt(t, 0) },
-    row_below: { label: "Insert row below", msg: "menuInsertRowBelow", run: (t) => insertRowAt(t, 1) },
-    remove_row: { label: "Remove row", msg: "menuRemoveRow", run: removeRowAt },
-    remove_col: { label: "Remove column", msg: "menuRemoveColumn", run: removeColAt },
-    comment: { label: "Edit comment", msg: "menuEditComment", run: (t) => openCommentEditor(t) },
-    // Charting: open the chart panel scoped to the current cell selection. Gated
-    // on `chartingEnabled` in the resolver below.
-    chart: { label: "Chart selected range", msg: "chartRange", run: () => { ctx.chartPanelOpen = true; } },
-  };
-  const DEFAULT_ITEMS = [
-    "copy", "cut", "paste", "clear", "separator",
-    "row_above", "row_below", "remove_row", "separator", "remove_col",
-  ];
-
-  function openContextMenu(
-    event: MouseEvent,
-    rowIndex: number,
-    colIndex: number,
-    columnId: string,
-  ) {
-    if (!ctx.props.contextMenu) return;
-    event.preventDefault();
-    closeMenus();
-    ctx.contextMenuFor = null;
-    const rowModel = ctx.allRows[rowIndex];
-    const row = rowModel?.original ?? null;
-    const rowId = rowModel?.id ?? String(rowIndex);
-    // Reserve ~280px for the menu body. If the click is in the bottom third,
-    // flip the menu above the cursor so it stays fully in the viewport.
-    const menuHeight = 280;
-    const y = event.clientY + menuHeight > window.innerHeight
-      ? Math.max(8, event.clientY - menuHeight)
-      : event.clientY;
-    ctx.contextMenuPos = {
-      x: clampMenuX(event.clientX, 220),
-      y,
-    };
-    ctx.contextMenuFor = { rowIndex, colIndex, columnId, rowId, row };
-  }
-
-  function closeContextMenu() {
-    ctx.contextMenuFor = null;
-  }
-
-  // ---- Editable comments ---------------------------------------------
-  function openCommentEditor(t: CtxTarget) {
-    const cur =
-      ctx.noteOverrides?.[t.rowId]?.[t.columnId] ??
-      ctx.props.notes?.[t.rowId]?.[t.columnId] ??
-      "";
-    ctx.commentDraft = cur;
-    ctx.commentEditFor = { rowId: t.rowId, columnId: t.columnId, x: ctx.contextMenuPos.x, y: ctx.contextMenuPos.y };
-    ctx.contextMenuFor = null;
-  }
-  function writeNote(rowId: string, columnId: string, note: string) {
-    const next = { ...ctx.noteOverrides };
-    next[rowId] = { ...(next[rowId] ?? {}), [columnId]: note };
-    ctx.noteOverrides = next;
-    ctx.props.onNoteChange?.({ rowId, columnId, note });
-  }
-  function saveComment() {
-    const e = ctx.commentEditFor;
-    if (!e) return;
-    writeNote(e.rowId, e.columnId, ctx.commentDraft);
-    ctx.commentEditFor = null;
-  }
-  function removeComment() {
-    const e = ctx.commentEditFor;
-    if (!e) return;
-    writeNote(e.rowId, e.columnId, "");
-    ctx.commentEditFor = null;
-  }
-  function closeCommentEditor() {
-    ctx.commentEditFor = null;
-  }
-
-  /** Resolve the configured items against the current target for rendering. */
-  function contextMenuItems(): ResolvedItem[] {
-    const target = ctx.contextMenuFor as CtxTarget | null;
-    if (!target) return [];
-    const cfg = ctx.props.contextMenu;
-    const messages = ctx.messages;
-    const entries: any[] = Array.isArray(cfg)
-      ? cfg
-      : [
-          ...DEFAULT_ITEMS,
-          ...(ctx.chartingEnabled ? ["separator", "chart"] : []),
-          ...(ctx.props.editableComments ? ["separator", "comment"] : []),
-        ];
-    const out: ResolvedItem[] = [];
-    for (const entry of entries) {
-      if (entry === "separator") { out.push({ key: "sep" + out.length, label: "", separator: true }); continue; }
-      if (typeof entry === "string") {
-        // The chart item only makes sense when charting is enabled.
-        if (entry === "chart" && !ctx.chartingEnabled) continue;
-        const b = builtins[entry];
-        if (!b) continue;
-        const label = (b.msg && messages?.[b.msg]) || b.label;
-        out.push({ key: entry, label, run: () => b.run(target) });
-        continue;
-      }
-      if (entry.hidden?.(target)) continue;
-      out.push({
-        key: entry.key,
-        label: entry.label,
-        disabled: entry.disabled?.(target) ?? false,
-        run: () => entry.action(target),
-      });
-    }
-    // Drop leading/trailing/double separators.
-    return out.filter((it, i, a) =>
-      !it.separator || (i > 0 && i < a.length - 1 && !a[i - 1]?.separator),
-    );
-  }
-
-  return {
-    updateFilterRow,
-    updateFilterOperator,
-    updateFilterMenuValue,
-    updateFilterMenuValueTo,
-    addFilterToken,
-    removeFilterToken,
-    toggleFilterToken,
-    toggleCheckboxWithKeyboard,
-    isColumnFiltered,
-    closeMenus,
-    openInSuggest,
-    closeInSuggest,
-    openChooseColumns,
-    openColumnMenu,
-    openFilterMenu,
-    openOperatorMenu,
-    sortColumnFromMenu,
-    clearColumnSort,
-    groupByColumnFromMenu,
-    clearGroupingFromMenu,
-    isFacetChecked,
-    toggleFacetValue,
-    setFacetSelection,
-    setFilterTokens,
-    isAllFacetsChecked,
-    toggleAllFacets,
-    clearColumnFilter,
-    changePage,
-    goToPage,
-    setPageSize,
-    openContextMenu,
-    closeContextMenu,
-    contextMenuItems,
-    saveComment,
-    removeComment,
-    closeCommentEditor,
-  };
-}
+// menus handlers extracted from the controller. Imperative event handlers
+// reading/writing controller state via the `ctx` handle; the reactive core
+// ($state/$derived/$effect) stays in the controller.
+import {
+  type RowData,
+  type TableFeatures,
+} from "./index";
+import "./sv-grid-scrollbar";
+import { untrack } from "svelte";
+import type {
+  FilterOperator,
+} from "./SvGrid.types";
+import {
+  clampMenuX,
+  cssEscape,
+} from "./SvGrid.helpers";
+import { splitInTokens, joinInTokens } from "./filtering/excel-filters";
+
+export function createMenus<
+  TFeatures extends TableFeatures = TableFeatures,
+  TData extends RowData = RowData,
+>(ctx: any) {
+  function updateFilterRow(columnId: string, value: string) {
+    ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
+    const current = ctx.filterMenuValues[columnId] ?? {
+      operator: "contains" as const,
+      value: "",
+    };
+    ctx.filterMenuValues = {
+      ...ctx.filterMenuValues,
+      [columnId]: { ...current, value },
+    };
+  }
+
+  function updateFilterOperator(columnId: string, operator: FilterOperator) {
+    const current = ctx.filterMenuValues[columnId] ?? {
+      operator: "contains" as const,
+      value: "",
+    };
+    ctx.filterMenuValues = {
+      ...ctx.filterMenuValues,
+      [columnId]: { ...current, operator },
+    };
+  }
+
+  function updateFilterMenuValue(columnId: string, value: string) {
+    const current = ctx.filterMenuValues[columnId] ?? {
+      operator: "contains" as const,
+      value: "",
+    };
+    ctx.filterMenuValues = {
+      ...ctx.filterMenuValues,
+      [columnId]: { ...current, value },
+    };
+    ctx.filterRowValues = { ...ctx.filterRowValues, [columnId]: value };
+  }
+
+  /** Upper-bound input for the `between` operator. Only relevant when
+   *  the column's current operator is `between`; harmless to call
+   *  otherwise. */
+  function updateFilterMenuValueTo(columnId: string, valueTo: string) {
+    const current = ctx.filterMenuValues[columnId] ?? {
+      operator: "between" as const,
+      value: "",
+    };
+    ctx.filterMenuValues = {
+      ...ctx.filterMenuValues,
+      [columnId]: { ...current, valueTo },
+    };
+  }
+
+  /** Current `in` / `notIn` token list for a column (from the filter-row value). */
+  function filterTokens(columnId: string): string[] {
+    return splitInTokens(ctx.filterRowValues[columnId] ?? "");
+  }
+
+  /** Add a value to a column's `in` / `notIn` list (no-op if already present). */
+  function addFilterToken(columnId: string, token: string) {
+    const t = token.trim();
+    if (!t) return;
+    const tokens = filterTokens(columnId);
+    if (!tokens.includes(t)) tokens.push(t);
+    updateFilterRow(columnId, joinInTokens(tokens));
+  }
+
+  /** Remove a value from a column's `in` / `notIn` list. */
+  function removeFilterToken(columnId: string, token: string) {
+    updateFilterRow(
+      columnId,
+      joinInTokens(filterTokens(columnId).filter((t) => t !== token)),
+    );
+  }
+
+  /** Toggle a value in a column's `in` / `notIn` list (checklist behaviour). */
+  function toggleFilterToken(columnId: string, token: string) {
+    if (filterTokens(columnId).includes(token)) removeFilterToken(columnId, token);
+    else addFilterToken(columnId, token);
+  }
+
+  /**
+   * Replace a column's `in` / `notIn` list wholesale. The suggestions dropdown
+   * hands back the full token set after a click, which keeps tokens the user
+   * typed by hand (or that the search box is currently hiding) intact.
+   */
+  function setFilterTokens(columnId: string, tokens: Iterable<string>) {
+    const list = [...tokens].map((t) => t.trim()).filter(Boolean);
+    updateFilterRow(columnId, joinInTokens(list));
+  }
+
+  function toggleCheckboxWithKeyboard(
+    event: KeyboardEvent,
+    toggle: () => void,
+  ) {
+    if (event.key !== "Enter" && event.key !== " ") return;
+    event.preventDefault();
+    toggle();
+  }
+
+  function isColumnFiltered(columnId: string) {
+    if (ctx.valueFilters[columnId]) return true;
+    const menuFilter = ctx.filterMenuValues[columnId];
+    return Boolean(
+      menuFilter &&
+        (menuFilter.operator === "isBlank" ||
+          menuFilter.operator === "isNotBlank" ||
+          menuFilter.value.trim()),
+    );
+  }
+
+  function closeMenus() {
+    ctx.columnMenuFor = null;
+    ctx.filterMenuFor = null;
+    ctx.operatorMenuFor = null;
+    ctx.inSuggestFor = null;
+    ctx.chooseColumnsPos = null;
+  }
+
+  /** Open the `in` / `notIn` value-suggestions dropdown under a chip input. */
+  function openInSuggest(anchor: HTMLElement, columnId: string) {
+    const rect = anchor.getBoundingClientRect();
+    ctx.inSuggestPos = { x: clampMenuX(rect.left, 220), y: rect.bottom + 4 };
+    ctx.inSuggestQuery = "";
+    ctx.inSuggestFor = columnId;
+  }
+
+  function closeInSuggest() {
+    ctx.inSuggestFor = null;
+    ctx.inSuggestQuery = "";
+  }
+
+  function openChooseColumns(event: MouseEvent) {
+    event.stopPropagation();
+    // Submenu behavior: keep the parent operations menu open and float the
+    // Choose Columns panel out to the right of it (AG-Grid style). Falls
+    // back to below the item if the popover would clip the viewport.
+    const trigger = event.currentTarget as HTMLElement;
+    const menuEl = trigger.closest(".sv-grid-menu") as HTMLElement | null;
+    const anchor = (menuEl ?? trigger).getBoundingClientRect();
+    const panelWidth = 240;
+    const wantRight = anchor.right + 4;
+    const x =
+      wantRight + panelWidth + 8 > window.innerWidth
+        ? clampMenuX(anchor.left - panelWidth - 4, panelWidth)
+        : clampMenuX(wantRight, panelWidth);
+    ctx.chooseColumnsPos = { x, y: anchor.top };
+  }
+
+  function openColumnMenu(event: MouseEvent, columnId: string) {
+    event.stopPropagation();
+    const wasOpen = ctx.columnMenuFor === columnId;
+    closeMenus();
+    if (wasOpen) return;
+    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
+    ctx.columnMenuPos = {
+      x: clampMenuX(rect.right - 240, 240),
+      y: rect.bottom + 4,
+    };
+    ctx.columnMenuTab = "general";
+    ctx.columnMenuFor = columnId;
+  }
+
+  function openFilterMenu(event: MouseEvent, columnId: string) {
+    event.stopPropagation();
+    const wasOpen = ctx.filterMenuFor === columnId;
+    closeMenus();
+    if (wasOpen) return;
+
+    // If the consumer is running in row-mode (or any mode where the
+    // funnel popover wouldn't render), redirect the click to the
+    // inline filter input for this column. Without this the funnel
+    // would be a dead button - it visibly clicks but nothing happens
+    // because the menu is gated behind `showColumnFiltersEffective`.
+    if (!ctx.showColumnFiltersEffective && ctx.showFilterRowEffective) {
+      // Find the row-mode filter input and focus it. The input is
+      // tagged with `data-svgrid-filter-col` so we can target by id
+      // without depending on column position.
+      const input = (ctx.scrollContainer as HTMLElement | null)?.querySelector<HTMLInputElement>(
+        `[data-svgrid-filter-col="${cssEscape(columnId)}"]`,
+      );
+      if (input) {
+        input.focus();
+        input.select();
+        // Brief pulse so the user sees where focus landed.
+        input.classList.add("sv-grid-filter-value-pulse");
+        setTimeout(() => input.classList.remove("sv-grid-filter-value-pulse"), 700);
+      }
+      return;
+    }
+
+    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
+    ctx.filterMenuPos = {
+      x: clampMenuX(rect.right - 260, 260),
+      y: rect.bottom + 4,
+    };
+    ctx.columnMenuSearch = "";
+    ctx.filterMenuFor = columnId;
+  }
+
+  function openOperatorMenu(event: MouseEvent, columnId: string) {
+    event.stopPropagation();
+    const wasOpen = ctx.operatorMenuFor === columnId;
+    closeMenus();
+    if (wasOpen) return;
+    const rect = (event.currentTarget as HTMLElement).getBoundingClientRect();
+    ctx.operatorMenuPos = { x: clampMenuX(rect.left, 184), y: rect.bottom + 4 };
+    ctx.operatorMenuFor = columnId;
+  }
+
+  function sortColumnFromMenu(columnId: string, desc: boolean) {
+    ctx.grid.store.setState((prev: any) => ({
+      ...prev,
+      sorting: [{ id: columnId, desc }],
+    }));
+    closeMenus();
+  }
+
+  function clearColumnSort(columnId: string) {
+    ctx.grid.store.setState((prev: any) => ({
+      ...prev,
+      sorting: (prev.sorting ?? []).filter(
+        (entry: { id: string }) => entry.id !== columnId,
+      ),
+    }));
+    closeMenus();
+  }
+
+  function groupByColumnFromMenu(columnId: string) {
+    const current = ctx.grid.getState().grouping ?? [];
+    if (current.includes(columnId)) {
+      closeMenus();
+      return;
+    }
+    ctx.grid.setGrouping([...current, columnId]);
+    closeMenus();
+  }
+
+  function clearGroupingFromMenu(columnId: string) {
+    const current = ctx.grid.getState().grouping ?? [];
+    ctx.grid.setGrouping(current.filter((id: string) => id !== columnId));
+    closeMenus();
+  }
+
+  function isFacetChecked(columnId: string, value: string) {
+    const selected = ctx.valueFilters[columnId];
+    return selected ? selected.has(value) : true;
+  }
+
+  function toggleFacetValue(columnId: string, value: string) {
+    const allValues = ctx.columnMenuFacetValues;
+    const next = new Set(ctx.valueFilters[columnId] ?? allValues);
+    if (next.has(value)) next.delete(value);
+    else next.add(value);
+    if (next.size === allValues.length) {
+      const copy = { ...ctx.valueFilters };
+      delete copy[columnId];
+      ctx.valueFilters = copy;
+    } else {
+      ctx.valueFilters = { ...ctx.valueFilters, [columnId]: next };
+    }
+  }
+
+  /**
+   * Replace a column's checked-facet set. "Everything checked" is stored as an
+   * ABSENT entry (so an unfiltered high-cardinality column never holds a set of
+   * every value), which is why the full-size case deletes instead of writing.
+   */
+  function setFacetSelection(columnId: string, next: ReadonlySet<string>) {
+    if (next.size >= ctx.columnMenuFacetValues.length) {
+      const copy = { ...ctx.valueFilters };
+      delete copy[columnId];
+      ctx.valueFilters = copy;
+      return;
+    }
+    ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set(next) };
+  }
+
+  function isAllFacetsChecked(columnId: string) {
+    const selected = ctx.valueFilters[columnId];
+    return !selected || selected.size >= ctx.columnMenuFacetValues.length;
+  }
+
+  function toggleAllFacets(columnId: string) {
+    if (isAllFacetsChecked(columnId)) {
+      ctx.valueFilters = { ...ctx.valueFilters, [columnId]: new Set<string>() };
+    } else {
+      const copy = { ...ctx.valueFilters };
+      delete copy[columnId];
+      ctx.valueFilters = copy;
+    }
+  }
+
+  function clearColumnFilter(columnId: string) {
+    // `untrack`: read-modify-write on the filter maps. Keeps the method safe to
+    // call from a consumer's reactive `$effect` (e.g. via `api.clearFilter`)
+    // without capturing these reads as a dependency and looping. See
+    // `build-api`'s `setFilter` for the full rationale.
+    untrack(() => {
+      if (ctx.valueFilters[columnId]) {
+        const next = { ...ctx.valueFilters };
+        delete next[columnId];
+        ctx.valueFilters = next;
+      }
+      if (ctx.filterMenuValues[columnId]) {
+        const next = { ...ctx.filterMenuValues };
+        delete next[columnId];
+        ctx.filterMenuValues = next;
+      }
+      if (ctx.filterRowValues[columnId]) {
+        const next = { ...ctx.filterRowValues };
+        delete next[columnId];
+        ctx.filterRowValues = next;
+      }
+    });
+  }
+
+  // External pagination is controlled: emit the requested page/size and let
+  // the consumer fetch + update props. Never mutate local pagination state.
+  function emitExternalPagination(pageIndex: number, pageSize: number): boolean {
+    if (ctx.props.externalPagination !== true) return false;
+    ctx.props.onPaginationChange?.({ pageIndex: Math.max(0, pageIndex), pageSize });
+    ctx.scrollContainer?.scrollTo?.({ top: 0 });
+    return true;
+  }
+
+  function changePage(delta: number) {
+    if (
+      emitExternalPagination(
+        (ctx.props.pageIndex ?? 0) + delta,
+        ctx.props.pageSize ?? 10,
+      )
+    )
+      return;
+    ctx.grid.setPagination((prev: any) => ({
+      ...prev,
+      pageIndex: Math.max((prev?.pageIndex ?? 0) + delta, 0),
+    }));
+    ctx.scrollContainer?.scrollTo?.({ top: 0 });
+  }
+
+  function goToPage(pageIndex: number) {
+    if (emitExternalPagination(pageIndex, ctx.props.pageSize ?? 10)) return;
+    ctx.grid.setPagination((prev: any) => ({
+      ...prev,
+      pageIndex: Math.max(0, pageIndex),
+    }));
+    ctx.scrollContainer?.scrollTo?.({ top: 0 });
+  }
+
+  function setPageSize(pageSize: number) {
+    // External mode: changing page size resets to the first page.
+    if (emitExternalPagination(0, pageSize)) return;
+    ctx.grid.setPagination((prev: any) => {
+      const oldSize = prev?.pageSize ?? 10;
+      const oldIndex = prev?.pageIndex ?? 0;
+      // Keep the first visible row in view when the page size changes.
+      const firstVisibleRow = oldIndex * oldSize;
+      return {
+        ...prev,
+        pageSize,
+        pageIndex: Math.max(0, Math.floor(firstVisibleRow / pageSize)),
+      };
+    });
+  }
+
+  // ---- Right-click context menu --------------------------------------
+  type CtxTarget = { rowIndex: number; colIndex: number; columnId: string; rowId: string; row: TData | null };
+  type ResolvedItem = { key: string; label: string; separator?: boolean; disabled?: boolean; run?: () => void };
+
+  function insertRowAt(t: CtxTarget, offset: number) {
+    const data = ctx.internalData.slice() as TData[];
+    const idx = t.row ? data.indexOf(t.row) : -1;
+    const at = idx < 0 ? data.length : idx + offset;
+    data.splice(at, 0, {} as TData);
+    ctx.internalData = data;
+  }
+  function removeRowAt(t: CtxTarget) {
+    if (!t.row) return;
+    ctx.internalData = (ctx.internalData as TData[]).filter((r) => r !== t.row);
+  }
+  function removeColAt(t: CtxTarget) {
+    ctx.internalColumns = ctx.internalColumns.filter(
+      (d: any) => (d.id ?? d.field) !== t.columnId,
+    );
+  }
+
+  // Built-in items, keyed. `run` reads the live target passed at click time.
+  // `msg` names the GridMessages key so the label localizes (falls back to the
+  // English `label` when no `localeText` is set).
+  const builtins: Record<string, { label: string; msg?: string; run: (t: CtxTarget) => void }> = {
+    copy: { label: "Copy", msg: "menuCopy", run: () => ctx.copySelectionToClipboard() },
+    cut: { label: "Cut", msg: "menuCut", run: () => ctx.cutSelectionToClipboard() },
+    paste: { label: "Paste", msg: "menuPaste", run: () => void ctx.pasteFromClipboard() },
+    clear: { label: "Clear", msg: "menuClear", run: () => ctx.clearSelectedCells() },
+    row_above: { label: "Insert row above", msg: "menuInsertRowAbove", run: (t) => insertRowAt(t, 0) },
+    row_below: { label: "Insert row below", msg: "menuInsertRowBelow", run: (t) => insertRowAt(t, 1) },
+    remove_row: { label: "Remove row", msg: "menuRemoveRow", run: removeRowAt },
+    remove_col: { label: "Remove column", msg: "menuRemoveColumn", run: removeColAt },
+    comment: { label: "Edit comment", msg: "menuEditComment", run: (t) => openCommentEditor(t) },
+    // Charting: open the chart panel scoped to the current cell selection. Gated
+    // on `chartingEnabled` in the resolver below.
+    chart: { label: "Chart selected range", msg: "chartRange", run: () => { ctx.chartPanelOpen = true; } },
+  };
+  const DEFAULT_ITEMS = [
+    "copy", "cut", "paste", "clear", "separator",
+    "row_above", "row_below", "remove_row", "separator", "remove_col",
+  ];
+
+  function openContextMenu(
+    event: MouseEvent,
+    rowIndex: number,
+    colIndex: number,
+    columnId: string,
+  ) {
+    if (!ctx.props.contextMenu) return;
+    event.preventDefault();
+    closeMenus();
+    ctx.contextMenuFor = null;
+    const rowModel = ctx.allRows[rowIndex];
+    const row = rowModel?.original ?? null;
+    const rowId = rowModel?.id ?? String(rowIndex);
+    // Reserve ~280px for the menu body. If the click is in the bottom third,
+    // flip the menu above the cursor so it stays fully in the viewport.
+    const menuHeight = 280;
+    const y = event.clientY + menuHeight > window.innerHeight
+      ? Math.max(8, event.clientY - menuHeight)
+      : event.clientY;
+    ctx.contextMenuPos = {
+      x: clampMenuX(event.clientX, 220),
+      y,
+    };
+    ctx.contextMenuFor = { rowIndex, colIndex, columnId, rowId, row };
+  }
+
+  function closeContextMenu() {
+    ctx.contextMenuFor = null;
+  }
+
+  // ---- Editable comments ---------------------------------------------
+  function openCommentEditor(t: CtxTarget) {
+    const cur =
+      ctx.noteOverrides?.[t.rowId]?.[t.columnId] ??
+      ctx.props.notes?.[t.rowId]?.[t.columnId] ??
+      "";
+    ctx.commentDraft = cur;
+    ctx.commentEditFor = { rowId: t.rowId, columnId: t.columnId, x: ctx.contextMenuPos.x, y: ctx.contextMenuPos.y };
+    ctx.contextMenuFor = null;
+  }
+  function writeNote(rowId: string, columnId: string, note: string) {
+    const next = { ...ctx.noteOverrides };
+    next[rowId] = { ...(next[rowId] ?? {}), [columnId]: note };
+    ctx.noteOverrides = next;
+    ctx.props.onNoteChange?.({ rowId, columnId, note });
+  }
+  function saveComment() {
+    const e = ctx.commentEditFor;
+    if (!e) return;
+    writeNote(e.rowId, e.columnId, ctx.commentDraft);
+    ctx.commentEditFor = null;
+  }
+  function removeComment() {
+    const e = ctx.commentEditFor;
+    if (!e) return;
+    writeNote(e.rowId, e.columnId, "");
+    ctx.commentEditFor = null;
+  }
+  function closeCommentEditor() {
+    ctx.commentEditFor = null;
+  }
+
+  /** Resolve the configured items against the current target for rendering. */
+  function contextMenuItems(): ResolvedItem[] {
+    const target = ctx.contextMenuFor as CtxTarget | null;
+    if (!target) return [];
+    const cfg = ctx.props.contextMenu;
+    const messages = ctx.messages;
+    const entries: any[] = Array.isArray(cfg)
+      ? cfg
+      : [
+          ...DEFAULT_ITEMS,
+          ...(ctx.chartingEnabled ? ["separator", "chart"] : []),
+          ...(ctx.props.editableComments ? ["separator", "comment"] : []),
+        ];
+    const out: ResolvedItem[] = [];
+    for (const entry of entries) {
+      if (entry === "separator") { out.push({ key: "sep" + out.length, label: "", separator: true }); continue; }
+      if (typeof entry === "string") {
+        // The chart item only makes sense when charting is enabled.
+        if (entry === "chart" && !ctx.chartingEnabled) continue;
+        const b = builtins[entry];
+        if (!b) continue;
+        const label = (b.msg && messages?.[b.msg]) || b.label;
+        out.push({ key: entry, label, run: () => b.run(target) });
+        continue;
+      }
+      if (entry.hidden?.(target)) continue;
+      out.push({
+        key: entry.key,
+        label: entry.label,
+        disabled: entry.disabled?.(target) ?? false,
+        run: () => entry.action(target),
+      });
+    }
+    // Drop leading/trailing/double separators.
+    return out.filter((it, i, a) =>
+      !it.separator || (i > 0 && i < a.length - 1 && !a[i - 1]?.separator),
+    );
+  }
+
+  return {
+    updateFilterRow,
+    updateFilterOperator,
+    updateFilterMenuValue,
+    updateFilterMenuValueTo,
+    addFilterToken,
+    removeFilterToken,
+    toggleFilterToken,
+    toggleCheckboxWithKeyboard,
+    isColumnFiltered,
+    closeMenus,
+    openInSuggest,
+    closeInSuggest,
+    openChooseColumns,
+    openColumnMenu,
+    openFilterMenu,
+    openOperatorMenu,
+    sortColumnFromMenu,
+    clearColumnSort,
+    groupByColumnFromMenu,
+    clearGroupingFromMenu,
+    isFacetChecked,
+    toggleFacetValue,
+    setFacetSelection,
+    setFilterTokens,
+    isAllFacetsChecked,
+    toggleAllFacets,
+    clearColumnFilter,
+    changePage,
+    goToPage,
+    setPageSize,
+    openContextMenu,
+    closeContextMenu,
+    contextMenuItems,
+    saveComment,
+    removeComment,
+    closeCommentEditor,
+  };
+}