@ixfx/components 0.15.4 → 0.16.0

package/dist/{data-grid-CbiubdG2.d.ts → data-grid-CIG2DVip.d.ts}

@@ -1,8 +1,10 @@
-import "./icon-DR_3rSyZ.js";
-import { B as ListNativeDragStartEvent, I as ListDragPreviewRenderer, L as ListDragPreviewSourceResolver } from "./tree-component-C6UHO-w9.js";
+import "./icon-CDGprSdE.js";
+import { L as ListDragPreviewRenderer, R as ListDragPreviewSourceResolver, V as ListNativeDragStartEvent } from "./tree-component-DgfkxmVY.js";
+import { a as ViewStateBase, t as GetViewStateOptions } from "./types-LU1u0CB8.js";
+import "./index-9ttcdwlL.js";
 import { n as ListViewportChangeEvent, t as ListViewportChangeDetail } from "./list-viewport-types-BRZsLcvp.js";
-import { S as ListSearchController } from "./index-BPTuCRGb.js";
-import "./index-cnaRPQPp.js";
+import { S as ListSearchController } from "./index-Dr80Zdl6.js";
+import "./index-DxyyVqzA.js";
 import "./pan-text-CoYmt2qd.js";
 import { LitElement } from "lit";
 import { CommandId, CommandRegistry } from "@clinth/ui-commands";
@@ -52,6 +54,12 @@ type DataGridColumn<R = unknown> = {
   button?: false | true | {
     icon?: string;
   };
+  /** Heading for this column in the built-in column menu; columns sharing a group are listed in one submenu. Ungrouped columns stay at the top level. */
+  group?: string;
+  /** Pixels added to the measured text width when auto-sizing (e.g. a thumbnail beside the text). Lets a `renderer` column be auto-sized. */
+  fixedExtraWidth?: number;
+  /** Custom content-width measure (px) for one row, used when auto-sizing. Lets a `renderer` column be auto-sized. */
+  measure?: (row: R, col: DataGridColumn<R>) => number;
 };
 type GlobalFormatter = (value: unknown, columnName: string, row: unknown) => unknown;
 /**
@@ -93,6 +101,31 @@ type DataGridGroupLabel = (groupKey: string, rows: readonly unknown[]) => string
 /** Whether the data-grid renders its built-in header column/group menu. */
 type DataGridColumnMenu = `auto` | `none`;
 //#endregion
+//#region src/data-grid/data-grid-view-state.d.ts
+/**
+ * Pure view-state helpers for `ixfx-data-grid`. The grid runs these whenever
+ * its rows or columns change, so state keyed to rows / columns that left the
+ * data goes pending and comes back when those keys reappear.
+ */
+/** Saved layout for one column, keyed by column key in {@link DataGridViewState.columns}. */
+type DataGridColumnViewState = {
+  readonly width?: number;
+  readonly visible?: boolean;
+  /** Rank among the saved columns (lower is further left). */
+  readonly order?: number;
+};
+/**
+ * `ixfx-data-grid` view state. `expanded` is keyed by group key; groups
+ * default to open, so a collapsed group is `false`.
+ */
+type DataGridViewState = ViewStateBase & {
+  readonly columns?: Readonly<Record<string, DataGridColumnViewState>>;
+  /** Sorted column + direction; `null` means unsorted. */
+  readonly sort?: DataGridSortState;
+  /** Group-by column key (`null` = ungrouped). Only recorded when `allowGrouping` is on. */
+  readonly groupBy?: string | null;
+};
+//#endregion
 //#region src/data-grid/data-grid.d.ts
 type DataGridSortDetail = {
   readonly sort: DataGridSortState;
@@ -361,14 +394,30 @@ declare class DataGridElement extends LitElement {
   /**
    * Resize a single column, by key, to fit its contents (header label + every
    * row's formatted value), animating the width change smoothly. Only works
-   * for plain columns - one with a custom `renderer` can't be measured
-   * reliably from its raw value, so it's left untouched. Returns `false` (and
-   * does nothing) if the column doesn't exist, isn't resizable, or has a
-   * `renderer`.
+   * for plain columns, or `renderer` columns that supply `measure` or
+   * `fixedExtraWidth` - otherwise a renderer's output can't be measured
+   * reliably from the raw value, so it's left untouched. Returns `false` (and
+   * does nothing) if the column doesn't exist, isn't resizable, or has an
+   * unmeasurable `renderer`.
    */
   autoSizeColumn(key: string): boolean;
   private _columnResizeAnimationMs;
   private _onResizePointerDown;
+  /**
+   * Snapshot selection, cursor, scroll, collapsed groups, column layout, sort
+   * and (with `allowGrouping`) grouping as plain JSON, keyed by row / group /
+   * column key. Includes pending state for keys not currently present. Rows
+   * keyed by index (no `key` / `id` under the default `getRowKey`) are never
+   * recorded.
+   */
+  getViewState(options?: GetViewStateOptions<DataGridViewState>): DataGridViewState;
+  /**
+   * Apply saved view state. Fields present replace the current ones; row and
+   * column keys that aren't defined yet are applied as they appear (including
+   * rows streamed in with `appendRows()`).
+   */
+  setViewState(state: Partial<DataGridViewState>): void;
+  clearPendingViewState(): void;
   getVisibleRange(): {
     startRow: number;
     endRow: number;
@@ -391,4 +440,4 @@ interface DataGridElement {
   removeEventListener: (<K extends keyof DataGridElementEventMap>(type: K, listener: (this: DataGridElement, event: DataGridElementEventMap[K]) => void, options?: boolean | EventListenerOptions) => void) & ((type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void);
 }
 //#endregion
-export { DataGridEditorFactory as A, GlobalFormatter as B, BuiltInFormatterName as C, DataGridDataType as D, DataGridColumnMenu as E, DataGridInteractionMode as F, DataGridRowLook as I, DataGridSelectionMode as L, DataGridGetRowKey as M, DataGridGroupBy as N, DataGridEditability as O, DataGridGroupLabel as P, DataGridSortDirection as R, DataGridViewportChangeEvent as S, DataGridColumn as T, DataGridSelectDetail as _, DataGridColumnReorderDetail as a, DataGridSortEvent as b, DataGridColumnResizeEvent as c, DataGridElement as d, DataGridElementEventMap as f, DataGridRowActivateEvent as g, DataGridRowActivateDetail as h, DataGridCellEditEvent as i, DataGridEditorType as j, DataGridEditorContext as k, DataGridColumnVisibilityDetail as l, DataGridGroupChangeEvent as m, DataGridCellClickEvent as n, DataGridColumnReorderEvent as o, DataGridGroupChangeDetail as p, DataGridCellEditDetail as r, DataGridColumnResizeDetail as s, DataGridCellClickDetail as t, DataGridColumnVisibilityEvent as u, DataGridSelectEvent as v, BuiltInFormatterOptions as w, DataGridViewportChangeDetail as x, DataGridSortDetail as y, DataGridSortState as z };
+export { DataGridEditability as A, DataGridSortDirection as B, DataGridColumnViewState as C, DataGridColumn as D, BuiltInFormatterOptions as E, DataGridGroupBy as F, GlobalFormatter as H, DataGridGroupLabel as I, DataGridInteractionMode as L, DataGridEditorFactory as M, DataGridEditorType as N, DataGridColumnMenu as O, DataGridGetRowKey as P, DataGridRowLook as R, DataGridViewportChangeEvent as S, BuiltInFormatterName as T, DataGridSortState as V, DataGridSelectDetail as _, DataGridColumnReorderDetail as a, DataGridSortEvent as b, DataGridColumnResizeEvent as c, DataGridElement as d, DataGridElementEventMap as f, DataGridRowActivateEvent as g, DataGridRowActivateDetail as h, DataGridCellEditEvent as i, DataGridEditorContext as j, DataGridDataType as k, DataGridColumnVisibilityDetail as l, DataGridGroupChangeEvent as m, DataGridCellClickEvent as n, DataGridColumnReorderEvent as o, DataGridGroupChangeDetail as p, DataGridCellEditDetail as r, DataGridColumnResizeDetail as s, DataGridCellClickDetail as t, DataGridColumnVisibilityEvent as u, DataGridSelectEvent as v, DataGridViewState as w, DataGridViewportChangeDetail as x, DataGridSortDetail as y, DataGridSelectionMode as z };