@jielga/tmdatagrid 2.2.0 → 2.4.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { BoxProps, MantineSize, MenuProps } from "@mantine/core";
 import { CSSProperties, ComponentType, MouseEvent, MutableRefObject, ReactNode } from "react";
-import { AccessorFn, AccessorFnColumnDef, AccessorKeyColumnDef, Cell, Column, ColumnFiltersState, ColumnHelper, ColumnPinningState, DeepKeys, DeepValue, DisplayColumnDef, ExpandedState, FilterMeta, GroupColumnDef, Header, IdentifiedColumnDef, Row, RowData, RowSelectionState, Table, TableFeatures, TableOptions, TableState, aggregationFns } from "@tanstack/react-table";
+import { AccessorFn, AccessorFnColumnDef, AccessorKeyColumnDef, Cell, Column, ColumnDef, ColumnFiltersState, ColumnHelper, ColumnPinningState, DeepKeys, DeepValue, DisplayColumnDef, ExpandedState, FilterMeta, GroupColumnDef, Header, IdentifiedColumnDef, Row, RowData, RowSelectionState, Table, TableFeatures, TableOptions, TableState, aggregationFns } from "@tanstack/react-table";
 import { Store } from "@tanstack/store";
 import { AnyFieldApi, AnyFormApi, StandardSchemaV1 } from "@tanstack/react-form";
 import { RankingInfo } from "@tanstack/match-sorter-utils";
@@ -815,7 +815,7 @@ type TMDataGridLabels = {
   filterTo: string;
   /** `DgTriStateFilter`'s no-filter segment. */
   filterAll: string;
-  /** What a boolean column's `true` reads as - its filter choice and cell text. */
+  /** What a boolean `true` reads as - its filter choice, filter pill and group row. */
   booleanTrue: string;
   booleanFalse: string;
   addFilter: string;
@@ -1037,6 +1037,14 @@ type TMDataGridColumnFilterOptions = {
    * See {@link TMDataGridFilterControlComponent}.
    */
   control?: TMDataGridFilterControlComponent;
+  /**
+   * Whether this column's filter goes into the `persist.urlKey` search param.
+   * Defaults to `true`. `false` keeps it out of the param, on read and on
+   * write. Only has an effect when `urlKey` carries `columnFilters`, and since such
+   * a slice is not stored under `dataKey` either, the filter is then not
+   * persisted anywhere.
+   */
+  url?: boolean;
 };
 //#endregion
 //#region .types-tmp/core/filterSurface.d.ts
@@ -1173,11 +1181,31 @@ type TMDataGridSettingsSlice = (typeof SETTINGS_STATE_SLICES)[number];
 type TMDataGridPersistKey<TSlice extends string> = string | readonly [key: string, slices: readonly TSlice[]];
 /** Same values as Mantine's `StorageType`, which the package does not re-export. */
 type TMDataGridStorageMode = "localStorage" | "sessionStorage";
+/**
+ * Reads and writes the one URL search param that `urlKey` names. Replaces the
+ * default, which reads `window.location.search` and writes with
+ * `history.replaceState`, for a router that owns the URL.
+ */
+type TMDataGridUrlStorage = {
+  /** The param's current value, or `null` when the URL has none. */
+  get(name: string): string | null;
+  /** Sets the param to `value`, or removes it when `value` is `null`. */
+  set(name: string, value: string | null): void;
+};
 type TMDataGridPersistence = {
   /** Key for filters, global filter, sorting and pagination. */
   dataKey?: TMDataGridPersistKey<TMDataGridDataSlice>;
   /** Key for column visibility, sizing, order and pinning. */
   settingsKey?: TMDataGridPersistKey<TMDataGridSettingsSlice>;
+  /**
+   * Search param for data slices kept in the URL, so a link opens the grid on
+   * the same state. Takes the slices it lists away from `dataKey`. The param
+   * holds only the slices that differ from the initial state, and carries no
+   * version stamp.
+   */
+  urlKey?: TMDataGridPersistKey<TMDataGridDataSlice>;
+  /** Where `urlKey` reads and writes. Defaults to the browser's URL. */
+  urlStorage?: TMDataGridUrlStorage;
   /** Which storage area to use. Defaults to `"localStorage"`. */
   storageMode?: TMDataGridStorageMode;
   /** Serializes a payload before it is stored. Defaults to `JSON.stringify`. */
@@ -1437,6 +1465,209 @@ type ResolveRangeBoundsArgs = {
  */
 declare function resolveRangeBounds({ range, rowIndexOf, columnIndexOf }: ResolveRangeBoundsArgs): TMDataGridRangeBounds | null;
 //#endregion
+//#region .types-tmp/core/urlState.d.ts
+/**
+ * Typed deep links.
+ *
+ * `createTMDataGridColumnHelper` returns columns that carry, in their type
+ * only, what a link needs to know about them: the id, the `meta.type`, the
+ * value type, the offered operators, and whether the column can be filtered,
+ * sorted and put in the URL. `createTMDataGridUrlState` reads that from the
+ * grid's own columns, so a link can name only what the grid can show: a
+ * filter on a column the grid lacks, an operator its type does not offer or a
+ * value of the wrong type is a compile error, not a link that silently opens
+ * unfiltered.
+ *
+ * Nothing here is visible at runtime except the definition object. The
+ * column brand is a type, never a property.
+ */
+/**
+ * What a column built with `createTMDataGridColumnHelper` tells a typed link
+ * about itself. Read from literal values in the column definition: a value
+ * that is not a literal (`enableSorting: isAdmin`) reads as "not allowed".
+ */
+type TMDataGridColumnInfo = {
+  /** The column id, by TanStack's rule: `id`, else the accessor key with `.` replaced by `_`. */
+  id: string;
+  /** `meta.type`, `"string"` when unset. */
+  type: TMDataGridColumnType;
+  /** The value type the accessor returns. */
+  value: unknown;
+  /** `meta.filter.operators`, every operator when unset. */
+  operators: TMDataGridFilterOperator;
+  /** `enableColumnFilter` is not `false`. */
+  filterable: boolean;
+  /** `enableSorting` is not `false`. */
+  sortable: boolean;
+  /** `meta.filter.url` is not `false`. */
+  url: boolean;
+};
+declare const columnInfo: unique symbol;
+/**
+ * The type-only brand a column helper column carries. Never present at
+ * runtime, so spreading, cloning or serializing a column is unaffected.
+ */
+type TMDataGridTypedColumn<TInfo extends TMDataGridColumnInfo> = {
+  readonly [columnInfo]: TInfo;
+};
+/** The info of every leaf column in `TColumn`, a group's children included. */
+type TMDataGridColumnInfoOf<TColumn> = TColumn extends TMDataGridTypedColumn<infer TInfo> ? TInfo : never;
+/** `"address.city"` becomes `"address_city"`, as TanStack derives the id. */
+type DotsToUnderscores<S extends string> = S extends `${infer Head}.${infer Tail}` ? `${Head}_${DotsToUnderscores<Tail>}` : S;
+/**
+ * The column id the helper's `accessor` call produces: the explicit `id`,
+ * else the accessor key. An accessor function without an `id` gets `never`,
+ * which no link can name.
+ */
+type TMDataGridAccessorColumnId<TAccessor, TId extends string> = [TId] extends [never] ? TAccessor extends string ? DotsToUnderscores<TAccessor> : never : TId;
+/**
+ * The column options whose literal values a typed link reads. Intersected into
+ * the column helper's parameter so each one is inferred as a literal.
+ *
+ * @internal
+ */
+type TMDataGridColumnInfoHints<TId extends string, TType extends TMDataGridColumnType, TOperator extends TMDataGridFilterOperator, TFilterable extends boolean, TSortable extends boolean, TUrl extends boolean> = {
+  id?: TId;
+  enableColumnFilter?: TFilterable;
+  enableSorting?: TSortable;
+  meta?: {
+    type?: TType;
+    filter?: {
+      operators?: ReadonlyArray<TOperator>;
+      url?: TUrl;
+    };
+  };
+};
+/** A `Date`, or an ISO `YYYY-MM-DD` string. */
+type TMDataGridDateInput = Date | string;
+/** One choice of a select column: the value, or an element of an array value. */
+type OptionOf<TValue> = NonNullable<TValue> extends ReadonlyArray<infer TElement> ? TElement : NonNullable<TValue>;
+type ScalarInput = {
+  string: string;
+  number: number;
+  date: TMDataGridDateInput;
+  boolean: boolean;
+  select: string;
+  multiSelect: string;
+};
+type RangeEnd<TType extends TMDataGridColumnType> = TType extends "date" ? TMDataGridDateInput : TType extends "number" ? number : string;
+/** One filter on one column: an operator, and the value that operator takes. */
+type FilterInputFor<TType extends TMDataGridColumnType, TValue, TOperator extends TMDataGridFilterOperator> = TOperator extends "isEmpty" | "isNotEmpty" ? {
+  operator: TOperator;
+} : TOperator extends "isAnyOf" | "isNoneOf" ? {
+  operator: TOperator;
+  value: ReadonlyArray<OptionOf<TValue>>;
+} : TOperator extends "between" ? {
+  operator: TOperator;
+  /** `null` leaves that end open. */
+  value: readonly [from: RangeEnd<TType> | null, to: RangeEnd<TType> | null];
+} : {
+  operator: TOperator;
+  value: ScalarInput[TType];
+};
+/** Columns a link may filter: filterable, and not kept out of the URL. */
+type LinkFilterable<TInfo extends TMDataGridColumnInfo> = Extract<TInfo, {
+  filterable: true;
+  url: true;
+}>;
+/**
+ * The `filters` a link accepts: one optional entry per filterable column.
+ * With no filterable column it accepts no entry at all - an empty object type
+ * would let any key through, since TypeScript skips the unknown-key check
+ * against `{}`.
+ */
+type TMDataGridUrlFiltersInput<TInfo extends TMDataGridColumnInfo> = [LinkFilterable<TInfo>] extends [never] ? Record<string, never> : { [TColumn in LinkFilterable<TInfo> as TColumn["id"]]?: FilterInputFor<TColumn["type"], TColumn["value"], Extract<OperatorsByColumnType[TColumn["type"]], TColumn["operators"]>>; };
+/** The ids a link may sort by. */
+type TMDataGridUrlSortableId<TInfo extends TMDataGridColumnInfo> = Extract<TInfo, {
+  sortable: true;
+}>["id"];
+type Carries<TSlices extends ReadonlyArray<TMDataGridDataSlice>, TSlice extends TMDataGridDataSlice> = TSlice extends TSlices[number] ? true : false;
+/** What a link may set: only the slices the definition carries, only the grid's columns. */
+type TMDataGridUrlInput<TInfo extends TMDataGridColumnInfo, TSlices extends ReadonlyArray<TMDataGridDataSlice>> = (Carries<TSlices, "columnFilters"> extends true ? {
+  filters?: TMDataGridUrlFiltersInput<TInfo>;
+} : unknown) & (Carries<TSlices, "globalFilter"> extends true ? {
+  globalFilter?: string;
+} : unknown) & (Carries<TSlices, "sorting"> extends true ? {
+  sorting?: ReadonlyArray<{
+    id: TMDataGridUrlSortableId<TInfo>;
+    /** Defaults to `false`. */
+    desc?: boolean;
+  }>;
+} : unknown) & (Carries<TSlices, "pagination"> extends true ? {
+  pagination?: {
+    pageIndex: number;
+    pageSize: number;
+  };
+} : unknown);
+/** What the grid keeps in its URL param: the data slices, in the grid's own state shape. */
+type TMDataGridUrlPayload = {
+  columnFilters?: Array<TMDataGridColumnFilter>;
+  /** `null` is a search the user cleared, as opposed to one the link does not set. */
+  globalFilter?: string | null;
+  sorting?: Array<{
+    id: string;
+    desc: boolean;
+  }>;
+  pagination?: {
+    pageIndex: number;
+    pageSize: number;
+  };
+  expanded?: true | Record<string, boolean>;
+};
+/**
+ * A router's search, read and written as values rather than strings, for
+ * routers that keep objects in their search params and encode them
+ * themselves, such as TanStack Router.
+ */
+type TMDataGridUrlSearchStorage = {
+  /** The param's current value in the router's search, or `undefined`. */
+  get(name: string): unknown;
+  /** Sets the param to `value`, or removes it on `undefined`. */
+  set(name: string, value: TMDataGridUrlPayload | undefined): void;
+};
+type TMDataGridUrlState<TKey extends string, TSlices extends ReadonlyArray<TMDataGridDataSlice>, TInfo extends TMDataGridColumnInfo> = {
+  /** The URL search param. */
+  readonly key: TKey;
+  /** The data slices the param carries. */
+  readonly slices: TSlices;
+  /** For `persist.urlKey`. */
+  readonly urlKey: TMDataGridPersistKey<TMDataGridDataSlice>;
+  /** The param's value for a link, or `undefined` when the input sets nothing. */
+  payload(input: TMDataGridUrlInput<TInfo, TSlices>): TMDataGridUrlPayload | undefined;
+  /** The search object for a router link, `{ [key]: payload }`. */
+  search(input: TMDataGridUrlInput<TInfo, TSlices>): { [K in TKey]: TMDataGridUrlPayload | undefined; };
+  /**
+   * The search params for a plain link, encoded the way the grid's default
+   * `serialize` encodes them. Pass the `serialize` you gave `persist`, if any.
+   */
+  searchParams(input: TMDataGridUrlInput<TInfo, TSlices>, options?: {
+    serialize?: (payload: TMDataGridUrlPayload) => string;
+  }): URLSearchParams;
+  /**
+   * A route search validator: keeps the param when it is an object and drops
+   * anything else. The grid checks every slice itself when it reads the param.
+   */
+  validateSearch(search: Record<string, unknown>): { [K in TKey]?: TMDataGridUrlPayload; };
+  /**
+   * `urlKey`, plus a `urlStorage` over `storage` when one is given. Without
+   * one, the grid reads and writes the browser's URL itself.
+   */
+  persist(storage?: TMDataGridUrlSearchStorage): Pick<TMDataGridPersistence, "urlKey" | "urlStorage">;
+};
+/**
+ * Defines a grid's deep links from its columns. `columns` is the array the
+ * grid renders, built with `createTMDataGridColumnHelper`; it decides which
+ * filters, operators, values and sorts a link may name.
+ */
+declare function createTMDataGridUrlState<const TKey extends string, TColumns extends ReadonlyArray<unknown>, const TSlices extends ReadonlyArray<TMDataGridDataSlice> = typeof DATA_STATE_SLICES>(options: {
+  /** The URL search param. */
+  key: TKey;
+  /** The grid's columns. */
+  columns: TColumns;
+  /** The data slices the param carries. Defaults to every data slice. */
+  slices?: TSlices;
+}): TMDataGridUrlState<TKey, TSlices, TMDataGridColumnInfoOf<TColumns[number]>>;
+//#endregion
 //#region .types-tmp/core/export.d.ts
 type ErasedRow = Row<TMDataGridFeatures, TMDataGridRowData>;
 type ErasedColumn = Column<TMDataGridFeatures, TMDataGridRowData, unknown>;
@@ -1927,12 +2158,30 @@ type WithRowTypedMeta<TDef, TData extends RowData> = TDef extends unknown ? Omit
  * TanStack's column helper with `meta` typed against `TData`, so the
  * `meta.options` and `meta.edit.enabled` callbacks receive
  * `Row<TMDataGridFeatures, TData>`.
+ *
+ * Every column it returns also carries `TMDataGridColumnInfo` in its type,
+ * read from the literal values of `id`, `meta.type`,
+ * `meta.filter.operators`, `meta.filter.url`, `enableColumnFilter` and
+ * `enableSorting`. `createTMDataGridUrlState` reads it to type the links into
+ * the grid. TanStack's own return type keeps none of this: it types
+ * `accessorKey` as a plain string.
  */
 type TMDataGridColumnHelper<TData extends RowData> = {
-  accessor: <TAccessor extends AccessorFn<TData> | DeepKeys<TData>, TValue extends TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never>(accessor: TAccessor, column: WithRowTypedMeta<TAccessor extends AccessorFn<TData> ? DisplayColumnDef<TMDataGridFeatures, TData, TValue> : IdentifiedColumnDef<TMDataGridFeatures, TData, TValue>, TData>) => TAccessor extends AccessorFn<TData> ? AccessorFnColumnDef<TMDataGridFeatures, TData, TValue> : AccessorKeyColumnDef<TMDataGridFeatures, TData, TValue>;
+  accessor: <TAccessor extends AccessorFn<TData> | DeepKeys<TData>, TValue extends TAccessor extends AccessorFn<TData, infer TReturn> ? TReturn : TAccessor extends DeepKeys<TData> ? DeepValue<TData, TAccessor> : never, const TId extends string = never, TType extends TMDataGridColumnType = "string", TOperator extends TMDataGridFilterOperator = TMDataGridFilterOperator, TFilterable extends boolean = true, TSortable extends boolean = true, TUrl extends boolean = true>(accessor: TAccessor, column: WithRowTypedMeta<TAccessor extends AccessorFn<TData> ? DisplayColumnDef<TMDataGridFeatures, TData, TValue> : IdentifiedColumnDef<TMDataGridFeatures, TData, TValue>, TData> & TMDataGridColumnInfoHints<TId, TType, TOperator, TFilterable, TSortable, TUrl>) => (TAccessor extends AccessorFn<TData> ? AccessorFnColumnDef<TMDataGridFeatures, TData, TValue> : AccessorKeyColumnDef<TMDataGridFeatures, TData, TValue>) & TMDataGridTypedColumn<{
+    id: TMDataGridAccessorColumnId<TAccessor, TId>;
+    type: TType;
+    value: TValue;
+    operators: TOperator;
+    filterable: TFilterable;
+    sortable: TSortable;
+    url: TUrl;
+  }>;
   columns: ColumnHelper<TMDataGridFeatures, TData>["columns"];
   display: (column: WithRowTypedMeta<DisplayColumnDef<TMDataGridFeatures, TData>, TData>) => DisplayColumnDef<TMDataGridFeatures, TData, unknown>;
-  group: (column: WithRowTypedMeta<GroupColumnDef<TMDataGridFeatures, TData, unknown>, TData>) => GroupColumnDef<TMDataGridFeatures, TData, unknown>;
+  /** A header group. Carries the column info of every column under it. */
+  group: <const TChildren extends ReadonlyArray<ColumnDef<TMDataGridFeatures, TData, any>>>(column: WithRowTypedMeta<Omit<GroupColumnDef<TMDataGridFeatures, TData, unknown>, "columns">, TData> & {
+    columns: TChildren;
+  }) => GroupColumnDef<TMDataGridFeatures, TData, unknown> & TMDataGridTypedColumn<TMDataGridColumnInfoOf<TChildren[number]>>;
 };
 declare function createTMDataGridColumnHelper<TData extends RowData>(): TMDataGridColumnHelper<TData>;
 /** What the `renderDetails` render prop is handed for an expanded row. */
@@ -2310,8 +2559,9 @@ type UseTMDataGridOptions<TData extends RowData> = Omit<TableOptions<TMDataGridF
   getRowId: NonNullable<TableOptions<TMDataGridFeatures, TData>["getRowId"]>;
 }) & {
   /**
-   * Restore and persist table state across mounts. Two keys, because the two
-   * kinds of state have different lifetimes - see {@link TMDataGridPersistence}.
+   * Restore and persist table state across mounts. Two storage keys, because
+   * the two kinds of state have different lifetimes, and a URL search param
+   * for the data slices a link should carry - see {@link TMDataGridPersistence}.
    *
    * Keep the object referentially stable (module scope or `useMemo`); it is a
    * dependency of the subscription that writes back.
@@ -2642,6 +2892,22 @@ type TMDataGridFilterValue = {
 type TMDataGridColumnType = "string" | "number" | "boolean" | "date" | "select" | "multiSelect";
 type TMDataGridFilterOperator = "contains" | "equals" | "notEquals" | "startsWith" | "endsWith" | "greaterThan" | "greaterThanOrEqual" | "lessThan" | "lessThanOrEqual" | "between" | "before" | "after" | "onOrBefore" | "onOrAfter" | "isAnyOf" | "isNoneOf" | "isEmpty" | "isNotEmpty";
 declare const FILTER_OPERATOR_LABELS: Record<TMDataGridFilterOperator, string>;
+declare const OPERATORS_BY_TYPE: {
+  readonly string: readonly ["contains", "equals", "notEquals", "startsWith", "endsWith", "isEmpty", "isNotEmpty"];
+  readonly number: readonly ["equals", "notEquals", "greaterThan", "greaterThanOrEqual", "lessThan", "lessThanOrEqual", "between", "isEmpty", "isNotEmpty"];
+  readonly boolean: readonly ["equals", "notEquals", "isEmpty", "isNotEmpty"];
+  readonly date: readonly ["equals", "notEquals", "before", "after", "onOrBefore", "onOrAfter", "between", "isEmpty", "isNotEmpty"];
+  readonly select: readonly ["isAnyOf", "isNoneOf", "isEmpty", "isNotEmpty"];
+  readonly multiSelect: readonly ["isAnyOf", "isNoneOf", "isEmpty", "isNotEmpty"];
+};
+/**
+ * The operators each column type offers, as a type: the same lists the filter
+ * panel offers, so a typed link can never name an operator the panel lacks.
+ *
+ * @internal Feeds the typed links in urlState.ts; not exported from the
+ * package.
+ */
+type OperatorsByColumnType = { [TType in TMDataGridColumnType]: (typeof OPERATORS_BY_TYPE)[TType][number]; };
 declare function getOperatorsForType(type: TMDataGridColumnType): readonly TMDataGridFilterOperator[];
 declare function operatorNeedsValue(operator: TMDataGridFilterOperator): boolean;
 /** Whether the operator's value is a string array - `isAnyOf` / `isNoneOf`. */
@@ -2697,14 +2963,19 @@ declare function activeColumnFilters<TData extends RowData>(source: TMDataGridTa
  *
  * The type's default operator is left implicit - "First name: Sofia" reads the
  * way a person would say it - while any other operator is spelled out, since
- * that is the part a reader cannot guess.
+ * that is the part a reader cannot guess. A value with an option reads as the
+ * option's label, and a boolean as `labels.booleanTrue` / `booleanFalse`.
  */
-declare function formatFilterLabel({ label, type, filter, operatorLabels }: {
+declare function formatFilterLabel({ label, type, filter, operatorLabels, options, labels }: {
   label: string;
   type: TMDataGridColumnType;
   filter: TMDataGridFilterValue;
   /** Localized operator names - `labels.operators`. Defaults to English. */
   operatorLabels?: Record<TMDataGridFilterOperator, string>;
+  /** The column's options, so a value reads as its option's label. */
+  options?: ReadonlyArray<TMDataGridOption>;
+  /** What a boolean value reads as. Defaults to English. */
+  labels?: Pick<TMDataGridLabels, "booleanTrue" | "booleanFalse">;
 }): string;
 declare function matchesFilter(cellValue: unknown, { operator, value }: TMDataGridFilterValue): boolean;
 /**
@@ -3321,6 +3592,14 @@ type TMDataGridTableProps<TData extends RowData> = {
    * stay put while the virtualizer mounts and unmounts rows.
    */
   striped?: boolean;
+  /**
+   * Whether a body row takes the hover tint under the pointer. Unset, a row
+   * takes it when the row itself answers a gesture: `selectionMode: "row"`,
+   * a highlight mode, `onRowClick` or `renderRowContextMenu`. Group rows sit
+   * out those gestures and so sit out the tint too. `true` tints every row,
+   * `false` none. The row carries `data-highlight-on-hover` while it applies.
+   */
+  highlightOnHover?: boolean;
   /**
    * Called when the scroll *arrives* at an edge - once per arrival, not per
    * scroll event, and not on mount (the grid starts at the top-left edge).
@@ -3432,7 +3711,7 @@ type TMDataGridTableProps<TData extends RowData> = {
  * no-pagination mode work at any row count. Pagination is opt in through
  * `enablePagination`, or implied by `manualPagination`.
  */
-declare function TMDataGridTable$1<TData extends RowData = TMDataGridRowData>({ onRowClick, onCellClick, onCellDoubleClick, onCellContextMenu, rowClassName, rowStyle, striped, onScrollToTop, onScrollToBottom, onScrollToLeft, onScrollToRight, renderEmptyState, renderRowContextMenu, renderColumnMenuItems, rowContextMenuProps, onReachEnd, reachEndThreshold, "aria-label": ariaLabel, "aria-labelledby": ariaLabelledBy }: TMDataGridTableProps<TData>): import("react").JSX.Element;
+declare function TMDataGridTable$1<TData extends RowData = TMDataGridRowData>({ onRowClick, onCellClick, onCellDoubleClick, onCellContextMenu, rowClassName, rowStyle, striped, highlightOnHover, onScrollToTop, onScrollToBottom, onScrollToLeft, onScrollToRight, renderEmptyState, renderRowContextMenu, renderColumnMenuItems, rowContextMenuProps, onReachEnd, reachEndThreshold, "aria-label": ariaLabel, "aria-labelledby": ariaLabelledBy }: TMDataGridTableProps<TData>): import("react").JSX.Element;
 //#endregion
 //#region .types-tmp/components/TMDataGridToolbar.d.ts
 type TMDataGridToolbarProps = BoxProps & {
@@ -3589,6 +3868,16 @@ declare const ROW_NUMBER_COLUMN_ID = "__rowNumber__";
 //#region .types-tmp/components/TMDataGridGroupColumn.d.ts
 declare const GROUP_COLUMN_ID = "__group__";
 //#endregion
+//#region .types-tmp/core/valueText.d.ts
+type TMDataGridValueTextOptions = {
+  /** The column's `meta.type`. A `boolean` column's `"true"` / `"false"` filter strings read as booleans. */
+  type?: TMDataGridColumnType;
+  /** The column's resolved options: a value with an option reads as its label. */
+  options?: ReadonlyArray<TMDataGridOption>;
+  /** What `true` and `false` read as. Defaults to English. */
+  labels?: Pick<TMDataGridLabels, "booleanTrue" | "booleanFalse">;
+};
+//#endregion
 //#region .types-tmp/core/grouping.d.ts
 /**
  * The data rows under a group row, at any depth.
@@ -3609,8 +3898,10 @@ declare function getGroupDataRows<TData extends RowData>(row: Row<TMDataGridFeat
  * Deliberately not the grouped column's own `cell` renderer: that renderer is
  * written for a data row and is free to reach into `row.original`, which on a
  * group row is the first leaf's record rather than anything about the group.
+ * `options` carries what the chrome knows of the column instead - its type,
+ * its option labels and the boolean labels.
  */
-declare function formatGroupValue(value: unknown, blankLabel?: string): string;
+declare function formatGroupValue(value: unknown, blankLabel?: string, options?: TMDataGridValueTextOptions): string;
 //#endregion
 //#region .types-tmp/useTMDataGridExport.d.ts
 /** What {@link useTMDataGridExport} returns. */
@@ -4003,4 +4294,4 @@ declare function getSelectableRowIds<TData extends RowData>(row: Row<TMDataGridF
  */
 declare function resolveRowSelectionClick<TData extends RowData>({ rows, rowId, anchorRowId, modifiers, selection, canReplaceSelection }: ResolveRowSelectionClickArgs<TData>): ResolvedRowSelection;
 //#endregion
-export { type BuildExportDataArgs, type ColumnStepArgs, DATA_STATE_SLICES, DEFAULT_EXPORT_OPTIONS, DEFAULT_TMDATAGRID_SIZE, DETAILS_COLUMN_ID, DgAutocompleteFilter, DgDateRangeFilter, DgRangeSliderFilter, DgTriStateFilter, EDIT_COLUMN_ID, type ExportGridArgs, FILTER_OPERATOR_LABELS, GROUP_COLUMN_ID, type MoveColumnArgs, PERSIST_PAYLOAD_VERSION, ROW_NUMBER_COLUMN_ID, type ResolveRangeBoundsArgs, type ResolveRowSelectionClickArgs, type ResolvedRowSelection, SELECT_COLUMN_ID, SETTINGS_STATE_SLICES, SIZE_CONTROL_SIZE, SIZE_ROW_HEIGHT, TMDATAGRID_LABELS_EN, TMDATAGRID_LABELS_SV, TMDataGrid, type TMDataGridAddRowsOptions, type TMDataGridAddRowsResult, type TMDataGridAggregationName, type TMDataGridApi, TMDataGridBooleanEditor, type TMDataGridCapabilities, type TMDataGridCellEventArgs, type TMDataGridCellPosition, type TMDataGridCellRange, type TMDataGridCellSelectionMode, type TMDataGridClipboardTextOptions, type TMDataGridColSpanArgs, type TMDataGridColumnCapabilities, type TMDataGridColumnEditOptions, type TMDataGridColumnFilter, type TMDataGridColumnFilterOptions, type TMDataGridColumnHelper, type TMDataGridColumnMenuItemsArgs, type TMDataGridColumnMenuItemsRenderer, type TMDataGridColumnMeta, type TMDataGridColumnRegion, type TMDataGridColumnSearchable, type TMDataGridColumnType, type TMDataGridColumnsPanelProps, type TMDataGridCommitAllResult, type TMDataGridContextValue, type TMDataGridCsvFormatOptions, type TMDataGridDataSlice, TMDataGridDateEditor, type TMDataGridDetailsArgs, type TMDataGridDetailsRenderer, TMDataGridDraftActions, type TMDataGridDraftActionsActions, type TMDataGridDraftActionsControls, type TMDataGridDraftActionsProps, type TMDataGridDraftActionsSlotArgs, type TMDataGridDraftActionsState, type TMDataGridDropSide, type TMDataGridEditApi, type TMDataGridEditChange, type TMDataGridEditCommitArgs, type TMDataGridEditField, type TMDataGridEditMode, type TMDataGridEditRowProjection, type TMDataGridEditRowSnapshot, type TMDataGridEditState, type TMDataGridEditValueMap, type TMDataGridEditValueMapArgs, type TMDataGridEditingOptions, type TMDataGridEditorArgs, type TMDataGridEditorComponent, type TMDataGridExpandAllArgs, type TMDataGridExpandTarget, type TMDataGridExportApi, type TMDataGridExportColumns, type TMDataGridExportData, type TMDataGridExportFormat, type TMDataGridExportOptions, type TMDataGridExportPickerRequest, type TMDataGridExportRows, type TMDataGridExportSettings, type TMDataGridExportValueGetter, type TMDataGridExportWriteOptions, type TMDataGridFeatureFlags, type TMDataGridFeatures, type TMDataGridFieldValidate, type TMDataGridFilterControlArgs, type TMDataGridFilterControlComponent, type TMDataGridFilterControlLayout, type TMDataGridFilterFn, type TMDataGridFilterOperator, type TMDataGridFilterPanelLayout, type TMDataGridFilterPanelProps, TMDataGridFilterPills, type TMDataGridFilterPillsProps, type TMDataGridFilterSidebarSide, type TMDataGridFilterSurface, type TMDataGridFilterValue, TMDataGridFilterValueInput, type TMDataGridFilterValueShape, type TMDataGridFiltersOptions, type TMDataGridFiltersSettings, type TMDataGridFooterProps, type TMDataGridJsonFormatOptions, type TMDataGridLabels, type TMDataGridLabelsOverride, type TMDataGridMenuColumnsProps, type TMDataGridMenuExportProps, type TMDataGridMenuProps, TMDataGridMultiSelectEditor, TMDataGridNumberEditor, type TMDataGridOption, type TMDataGridOptionsArgs, type TMDataGridOptionsSource, type TMDataGridPaginationActions, type TMDataGridPaginationApi, type TMDataGridPaginationControls, type TMDataGridPaginationSlotArgs, type TMDataGridPaginationState, type TMDataGridPersistKey, type TMDataGridPersistence, type TMDataGridProps, type TMDataGridQuickSearchMode, type TMDataGridRangeBounds, type TMDataGridRowAddArgs, type TMDataGridRowClickModifiers, type TMDataGridRowContextMenuArgs, type TMDataGridRowContextMenuRenderer, type TMDataGridRowData, type TMDataGridRowDeleteArgs, type TMDataGridRowEditForm, type TMDataGridRowStyle, type TMDataGridRowValidators, type TMDataGridSaveDraftsArgs, type TMDataGridSaveDraftsResponse, type TMDataGridSaveDraftsResult, type TMDataGridSaveOutcomes, type TMDataGridScrollAlign, type TMDataGridScrollToRowArgs, TMDataGridSearch, type TMDataGridSearchProps, TMDataGridSelectEditor, type TMDataGridSelectionMode, type TMDataGridSettingsSlice, type TMDataGridSize, type TMDataGridStorageMode, TMDataGridStringEditor, type TMDataGridTable, type TMDataGridTableMeta, type TMDataGridTableProps, type TMDataGridTableValidateArgs, type TMDataGridTableValidators, type TMDataGridToolbarProps, type TMDataGridTsvFormatOptions, type TMDataGridUiActions, type TMDataGridUiState, type TMDataGridUiStore, type UseTMDataGridOptions, activeColumnFilters, aggregateColumn, areAllRowsExpanded, autosizeColumn, buildExportData, clearedValueForType, countSelectedExportRows, createTMDataGridColumnHelper, csvExcelFormat, csvFormat, downloadFile, emptyValueForOperator, exportGrid, filterValueShape, formatExportValue, formatFilterLabel, formatGroupValue, fuzzyGlobalFilterFn, getColumnCapabilities, getColumnDefaultOperator, getColumnLabel, getColumnOperators, getColumnRegion, getColumnType, getDisplayedRows, getEditFieldName, getExportableColumns, getGridCapabilities, getGroupDataRows, getOperatorsForType, getSelectableRowIds, getStepTargetColumn, getTMDataGridPaginationApi, guardFormula, hasPendingEdits, isControlColumn, isFilterActive, isGeneratedColumn, isPagingActive, jsonFormat, keepGeneratedColumnsOutermost, matchesFilter, mergeLabels, moveColumn, moveColumnByStep, normalizeFieldValidate, openColumnFilter, operatorNeedsValue, operatorTakesArrayValue, operatorTakesRangeValue, optionsToComboboxData, readFeatureFlags, resolveColumnOptions, resolveExpandAll, resolveExportOptions, resolveRangeBounds, resolveRowSelectionClick, tmDataGridFilterFn, toClipboardText, tsvFormat, useTMDataGrid, useTMDataGridContext, useTMDataGridExport, writeClipboardText, writeExportFile };
+export { type BuildExportDataArgs, type ColumnStepArgs, DATA_STATE_SLICES, DEFAULT_EXPORT_OPTIONS, DEFAULT_TMDATAGRID_SIZE, DETAILS_COLUMN_ID, DgAutocompleteFilter, DgDateRangeFilter, DgRangeSliderFilter, DgTriStateFilter, EDIT_COLUMN_ID, type ExportGridArgs, FILTER_OPERATOR_LABELS, GROUP_COLUMN_ID, type MoveColumnArgs, PERSIST_PAYLOAD_VERSION, ROW_NUMBER_COLUMN_ID, type ResolveRangeBoundsArgs, type ResolveRowSelectionClickArgs, type ResolvedRowSelection, SELECT_COLUMN_ID, SETTINGS_STATE_SLICES, SIZE_CONTROL_SIZE, SIZE_ROW_HEIGHT, TMDATAGRID_LABELS_EN, TMDATAGRID_LABELS_SV, TMDataGrid, type TMDataGridAddRowsOptions, type TMDataGridAddRowsResult, type TMDataGridAggregationName, type TMDataGridApi, TMDataGridBooleanEditor, type TMDataGridCapabilities, type TMDataGridCellEventArgs, type TMDataGridCellPosition, type TMDataGridCellRange, type TMDataGridCellSelectionMode, type TMDataGridClipboardTextOptions, type TMDataGridColSpanArgs, type TMDataGridColumnCapabilities, type TMDataGridColumnEditOptions, type TMDataGridColumnFilter, type TMDataGridColumnFilterOptions, type TMDataGridColumnHelper, type TMDataGridColumnInfo, type TMDataGridColumnInfoOf, type TMDataGridColumnMenuItemsArgs, type TMDataGridColumnMenuItemsRenderer, type TMDataGridColumnMeta, type TMDataGridColumnRegion, type TMDataGridColumnSearchable, type TMDataGridColumnType, type TMDataGridColumnsPanelProps, type TMDataGridCommitAllResult, type TMDataGridContextValue, type TMDataGridCsvFormatOptions, type TMDataGridDataSlice, TMDataGridDateEditor, type TMDataGridDateInput, type TMDataGridDetailsArgs, type TMDataGridDetailsRenderer, TMDataGridDraftActions, type TMDataGridDraftActionsActions, type TMDataGridDraftActionsControls, type TMDataGridDraftActionsProps, type TMDataGridDraftActionsSlotArgs, type TMDataGridDraftActionsState, type TMDataGridDropSide, type TMDataGridEditApi, type TMDataGridEditChange, type TMDataGridEditCommitArgs, type TMDataGridEditField, type TMDataGridEditMode, type TMDataGridEditRowProjection, type TMDataGridEditRowSnapshot, type TMDataGridEditState, type TMDataGridEditValueMap, type TMDataGridEditValueMapArgs, type TMDataGridEditingOptions, type TMDataGridEditorArgs, type TMDataGridEditorComponent, type TMDataGridExpandAllArgs, type TMDataGridExpandTarget, type TMDataGridExportApi, type TMDataGridExportColumns, type TMDataGridExportData, type TMDataGridExportFormat, type TMDataGridExportOptions, type TMDataGridExportPickerRequest, type TMDataGridExportRows, type TMDataGridExportSettings, type TMDataGridExportValueGetter, type TMDataGridExportWriteOptions, type TMDataGridFeatureFlags, type TMDataGridFeatures, type TMDataGridFieldValidate, type TMDataGridFilterControlArgs, type TMDataGridFilterControlComponent, type TMDataGridFilterControlLayout, type TMDataGridFilterFn, type TMDataGridFilterOperator, type TMDataGridFilterPanelLayout, type TMDataGridFilterPanelProps, TMDataGridFilterPills, type TMDataGridFilterPillsProps, type TMDataGridFilterSidebarSide, type TMDataGridFilterSurface, type TMDataGridFilterValue, TMDataGridFilterValueInput, type TMDataGridFilterValueShape, type TMDataGridFiltersOptions, type TMDataGridFiltersSettings, type TMDataGridFooterProps, type TMDataGridJsonFormatOptions, type TMDataGridLabels, type TMDataGridLabelsOverride, type TMDataGridMenuColumnsProps, type TMDataGridMenuExportProps, type TMDataGridMenuProps, TMDataGridMultiSelectEditor, TMDataGridNumberEditor, type TMDataGridOption, type TMDataGridOptionsArgs, type TMDataGridOptionsSource, type TMDataGridPaginationActions, type TMDataGridPaginationApi, type TMDataGridPaginationControls, type TMDataGridPaginationSlotArgs, type TMDataGridPaginationState, type TMDataGridPersistKey, type TMDataGridPersistence, type TMDataGridProps, type TMDataGridQuickSearchMode, type TMDataGridRangeBounds, type TMDataGridRowAddArgs, type TMDataGridRowClickModifiers, type TMDataGridRowContextMenuArgs, type TMDataGridRowContextMenuRenderer, type TMDataGridRowData, type TMDataGridRowDeleteArgs, type TMDataGridRowEditForm, type TMDataGridRowStyle, type TMDataGridRowValidators, type TMDataGridSaveDraftsArgs, type TMDataGridSaveDraftsResponse, type TMDataGridSaveDraftsResult, type TMDataGridSaveOutcomes, type TMDataGridScrollAlign, type TMDataGridScrollToRowArgs, TMDataGridSearch, type TMDataGridSearchProps, TMDataGridSelectEditor, type TMDataGridSelectionMode, type TMDataGridSettingsSlice, type TMDataGridSize, type TMDataGridStorageMode, TMDataGridStringEditor, type TMDataGridTable, type TMDataGridTableMeta, type TMDataGridTableProps, type TMDataGridTableValidateArgs, type TMDataGridTableValidators, type TMDataGridToolbarProps, type TMDataGridTsvFormatOptions, type TMDataGridTypedColumn, type TMDataGridUiActions, type TMDataGridUiState, type TMDataGridUiStore, type TMDataGridUrlFiltersInput, type TMDataGridUrlInput, type TMDataGridUrlPayload, type TMDataGridUrlSearchStorage, type TMDataGridUrlSortableId, type TMDataGridUrlState, type TMDataGridUrlStorage, type UseTMDataGridOptions, activeColumnFilters, aggregateColumn, areAllRowsExpanded, autosizeColumn, buildExportData, clearedValueForType, countSelectedExportRows, createTMDataGridColumnHelper, createTMDataGridUrlState, csvExcelFormat, csvFormat, downloadFile, emptyValueForOperator, exportGrid, filterValueShape, formatExportValue, formatFilterLabel, formatGroupValue, fuzzyGlobalFilterFn, getColumnCapabilities, getColumnDefaultOperator, getColumnLabel, getColumnOperators, getColumnRegion, getColumnType, getDisplayedRows, getEditFieldName, getExportableColumns, getGridCapabilities, getGroupDataRows, getOperatorsForType, getSelectableRowIds, getStepTargetColumn, getTMDataGridPaginationApi, guardFormula, hasPendingEdits, isControlColumn, isFilterActive, isGeneratedColumn, isPagingActive, jsonFormat, keepGeneratedColumnsOutermost, matchesFilter, mergeLabels, moveColumn, moveColumnByStep, normalizeFieldValidate, openColumnFilter, operatorNeedsValue, operatorTakesArrayValue, operatorTakesRangeValue, optionsToComboboxData, readFeatureFlags, resolveColumnOptions, resolveExpandAll, resolveExportOptions, resolveRangeBounds, resolveRowSelectionClick, tmDataGridFilterFn, toClipboardText, tsvFormat, useTMDataGrid, useTMDataGridContext, useTMDataGridExport, writeClipboardText, writeExportFile };