react-glide-table 1.7.0 → 2.0.2

package/dist/core.d.cts

@@ -1,6 +1,6 @@
-import { M as CellEditType, e as DataTableClassNames, R as RowSelectionMode, c as ColumnFreezeOffset, l as SearchResultItem, m as SearchStatus, h as DataTableProps, g as DataTableLabels, f as DataTableCopyActions, P as PasteMode, k as RowsPastePayload } from './types-Cs9MiZs1.cjs';
-export { C as ColumnFreezeColumnInput, a as ColumnFreezeEdgeSide, b as ColumnFreezeMeta, d as ColumnFreezeSide, D as DEFAULT_DATA_TABLE_LABELS, I as INLINE_SEARCH_MAX_RESULTS, S as SearchCorpusRow, p as buildColumnFreezeOffsets, q as buildFlatSearchCorpus, r as buildSearchMatchKey, s as buildSearchMatchKeys, t as buildTreeSearchCorpus, u as cellValueToSearchText, v as collectAncestorKeysToExpand, w as collectSearchMatchesInRange, x as createSearchRegex, y as escapeSearchRegex, z as formatSearchResultLabel, A as getColumnFreezeEdgeAttr, B as getColumnFreezeStyle, E as mapSearchResultToVisibleItem, F as mapSearchResultsToVisibleKeys, G as nextSearchIndex, H as nextSearchStride, J as previousSearchIndex, K as resolveColumnFreezeSide, L as resolveDataTableLabels } from './types-Cs9MiZs1.cjs';
-import { Row, ColumnDef, Table, Updater, RowSelectionState } from '@tanstack/react-table';
+import { W as CellEditType, c as CellRenderer, C as CellKind, a as CellRenderContext, i as DataTableClassNames, R as RowSelectionMode, g as ColumnFreezeOffset, p as SearchResultItem, q as SearchStatus, l as DataTableProps, k as DataTableLabels, j as DataTableCopyActions, P as PasteMode, o as RowsPastePayload } from './types-bgEceyRV.cjs';
+export { B as BuiltinCellKind, b as CellRenderFn, d as ColumnFreezeColumnInput, e as ColumnFreezeEdgeSide, f as ColumnFreezeMeta, h as ColumnFreezeSide, D as DEFAULT_DATA_TABLE_LABELS, I as INLINE_SEARCH_MAX_RESULTS, S as SearchCorpusRow, t as buildColumnFreezeOffsets, u as buildFlatSearchCorpus, v as buildSearchMatchKey, w as buildSearchMatchKeys, x as buildTreeSearchCorpus, y as cellValueToSearchText, z as collectAncestorKeysToExpand, A as collectSearchMatchesInRange, E as createSearchRegex, F as escapeSearchRegex, G as formatSearchResultLabel, H as getColumnFreezeEdgeAttr, J as getColumnFreezeStyle, K as mapSearchResultToVisibleItem, L as mapSearchResultsToVisibleKeys, M as nextSearchIndex, N as nextSearchStride, O as previousSearchIndex, Q as resolveColumnFreezeSide, U as resolveDataTableLabels, V as resolveHeaderFreezeOffset } from './types-bgEceyRV.cjs';
+import { Row, ColumnDef, CellContext, Table, Cell, Updater, RowSelectionState } from '@tanstack/react-table';
 export { ColumnDef, ColumnResizeMode, ColumnSizingState, RowSelectionState } from '@tanstack/react-table';
 import { Virtualizer, VirtualItem } from '@tanstack/react-virtual';
 import * as react from 'react';
@@ -36,6 +36,12 @@ declare function getCellEditDraftValue(value: unknown): string;
 /** Returns updated data on success; null if parsing fails or the cell is not editable */
 declare function applyCellEdit<T extends Record<string, unknown>>(data: T[], rows: Row<T>[], rowIndex: number, colIndex: number, raw: string): T[] | null;
 
+type CellRendererRegistry = Map<string, CellRenderer>;
+/** Later entries with the same `kind` override earlier ones (including builtins). */
+declare function createCellRendererRegistry(customRenderers?: readonly CellRenderer[]): CellRendererRegistry;
+declare function resolveCellRenderer<T extends Record<string, unknown>>(registry: CellRendererRegistry, kind: CellKind | undefined, ctx: CellRenderContext<T>): CellRenderer | undefined;
+declare function formatDefaultCellValue(value: unknown): string | null;
+
 type CellPosition = {
     row: number;
     col: number;
@@ -164,6 +170,10 @@ type DataTableRowContextValue = {
         onCommitEdit: (raw?: string) => boolean;
         onCancelEdit: () => void;
     };
+    cellRender: {
+        registry: CellRendererRegistry;
+        commitValue: (rowId: string, columnId: string, value: unknown) => boolean;
+    };
     expand: {
         enableExpand: boolean;
         toggleField?: string;
@@ -187,6 +197,19 @@ type DataTableRowContextValue = {
     };
 };
 
+/**
+ * TanStack `CellContext` with a guaranteed `update` commit helper.
+ * Prefer this over bare `cell.getContext()`, which does not include `update` at runtime.
+ */
+type CellContextWithUpdate<TData, TValue> = CellContext<TData, TValue> & {
+    update: (next: TValue) => void;
+};
+/**
+ * Injects `update` into a TanStack `CellContext` so `ColumnDef.cell` can commit
+ * through `onCellChange` / `onDataChange` the same way compound `Column.render` does.
+ */
+declare function withCellUpdate<TData extends Record<string, unknown>, TValue>(context: CellContext<TData, TValue>, commitValue: (rowId: string, columnId: string, value: unknown) => boolean): CellContextWithUpdate<TData, TValue>;
+
 type UseInlineSearchOptions = {
     enabled?: boolean;
     rowCount: number;
@@ -248,6 +271,11 @@ type UseGlideTableResult<T extends Record<string, unknown>> = {
     paddingTop: number;
     paddingBottom: number;
     rowContextValue: DataTableRowContextValue;
+    /**
+     * TanStack `CellContext` with `update` injected for custom `ColumnDef.cell` renders.
+     * Prefer this over `cell.getContext()` when calling `flexRender` yourself.
+     */
+    getCellContext: <TValue>(cell: Cell<T, TValue>) => CellContextWithUpdate<T, TValue>;
     handleToggleSelect: (row: Row<T>) => void;
     clearHover: () => void;
     copySelection: DataTableCopyActions["copySelection"];
@@ -284,6 +312,27 @@ declare function useCellEdit<T extends Record<string, unknown>>({ data, rows, on
     cancelEdit: () => void;
 };
 
+declare const BUILTIN_CELL_RENDERERS: CellRenderer[];
+
+type CommitCellValueOptions<T extends Record<string, unknown>> = {
+    data: T[];
+    rows: Row<T>[];
+    rowId: string;
+    columnId: string;
+    value: unknown;
+    onCellChange?: (rowId: string, columnId: string, value: unknown) => void;
+    onDataChange?: (data: T[]) => void;
+};
+/**
+ * Shared commit path for custom `render` updates and built-in cell kinds.
+ * Prefers `onCellChange`; falls back to immutable `onDataChange` patch.
+ */
+declare function commitCellValue<T extends Record<string, unknown>>({ data, rows, rowId, columnId, value, onCellChange, onDataChange, }: CommitCellValueOptions<T>): boolean;
+
+declare function ResolvedTableCell<T extends Record<string, unknown>>({ info, }: {
+    info: CellContext<T, unknown>;
+}): react.ReactNode;
+
 /** Width styles for header/body cells when column sizing is active. */
 declare function getColumnSizeStyle(size: number, options?: {
     force?: boolean;
@@ -350,6 +399,11 @@ type CopyRowEntry<T extends Record<string, unknown>> = {
     /** Tree depth relative to the table root (0 = top-level). */
     depth: number;
 };
+/**
+ * Clipboard / Excel paste expects one plain string per cell.
+ * Avoids `String(object)` → `[object Object]` and joins arrays with `, `.
+ */
+declare function formatCellValue(value: unknown): string;
 declare function flattenSubtreeRows<T extends Record<string, unknown>>(row: T): T[];
 /**
  * Collects copy rows with tree depth so paste can rebuild parent/child nesting.
@@ -409,4 +463,4 @@ declare const useConvertTreeData: <T extends Record<string, unknown>>({ data, en
 declare function resolveRowSelection(mode: RowSelectionMode, controlledSelection: RowSelectionState | undefined, internalSelection: RowSelectionState): RowSelectionState;
 declare function applySelectionUpdater(mode: RowSelectionMode, updater: Updater<RowSelectionState>, previous: RowSelectionState): RowSelectionState;
 
-export { CELL_SELECTION_EDGES_CLASS, type CellSelectionBounds, ColumnFreezeOffset, type ColumnRowSpanMap, type CopyRowEntry, type CopySelectionMode, DEFAULT_TREE_CHILDREN_FIELD, DEFAULT_TREE_ID_FIELD, DEFAULT_TREE_PARENT_ID_FIELD, DEFAULT_TREE_QTY_FIELD, DataTableCopyActions, DataTableLabels, DataTableProps, type DragState, type EditingCell, PasteMode, RowSelectionMode, type RowSpanInfo, RowsPastePayload, SearchResultItem, SearchStatus, type TreeRow, type UseConvertTreeDataParams, type UseGlideTableOptions, type UseGlideTableResult, type UseInlineSearchOptions, type UseInlineSearchResult, applyCellEdit, applyFillData, applySelectionUpdater, buildColumnRowSpanMap, buildRowsPastePayload, canExpandRow, collectCopyRowEntries, collectCopyRows, collectFillChanges, collectRowSpanColumns, flattenSubtreeRows, getCellEditDraftValue, getCellSelectionEdgeStyle, getColumnEditType, getColumnSizeStyle, getRowIndexInMergedCell, hasCellSelectionEdges, isCellInSelection, isColumnEditable, isEditablePasteTarget, measureMergedSpanRowHeights, parseCellEditValue, parseClipboardTSV, parseClipboardTSVWithDepths, resolvePasteColumnIds, resolveRowSelection, resolveRowSpanAt, rowRangeToHeightRatios, serializeCopyRowsToTSV, serializeSelectionToTSV, toggleExpandedRowId, useCellEdit, useCellSelection, useConvertTreeData, useGlideTable, useInlineSearch, writeSelectionToClipboard };
+export { BUILTIN_CELL_RENDERERS, CELL_SELECTION_EDGES_CLASS, type CellContextWithUpdate, CellKind, CellRenderContext, CellRenderer, type CellRendererRegistry, type CellSelectionBounds, ColumnFreezeOffset, type ColumnRowSpanMap, type CopyRowEntry, type CopySelectionMode, DEFAULT_TREE_CHILDREN_FIELD, DEFAULT_TREE_ID_FIELD, DEFAULT_TREE_PARENT_ID_FIELD, DEFAULT_TREE_QTY_FIELD, DataTableCopyActions, DataTableLabels, DataTableProps, type DragState, type EditingCell, PasteMode, ResolvedTableCell, RowSelectionMode, type RowSpanInfo, RowsPastePayload, SearchResultItem, SearchStatus, type TreeRow, type UseConvertTreeDataParams, type UseGlideTableOptions, type UseGlideTableResult, type UseInlineSearchOptions, type UseInlineSearchResult, applyCellEdit, applyFillData, applySelectionUpdater, buildColumnRowSpanMap, buildRowsPastePayload, canExpandRow, collectCopyRowEntries, collectCopyRows, collectFillChanges, collectRowSpanColumns, commitCellValue, createCellRendererRegistry, flattenSubtreeRows, formatCellValue, formatDefaultCellValue, getCellEditDraftValue, getCellSelectionEdgeStyle, getColumnEditType, getColumnSizeStyle, getRowIndexInMergedCell, hasCellSelectionEdges, isCellInSelection, isColumnEditable, isEditablePasteTarget, measureMergedSpanRowHeights, parseCellEditValue, parseClipboardTSV, parseClipboardTSVWithDepths, resolveCellRenderer, resolvePasteColumnIds, resolveRowSelection, resolveRowSpanAt, rowRangeToHeightRatios, serializeCopyRowsToTSV, serializeSelectionToTSV, toggleExpandedRowId, useCellEdit, useCellSelection, useConvertTreeData, useGlideTable, useInlineSearch, withCellUpdate, writeSelectionToClipboard };

package/dist/core.d.ts

@@ -1,6 +1,6 @@
-import { M as CellEditType, e as DataTableClassNames, R as RowSelectionMode, c as ColumnFreezeOffset, l as SearchResultItem, m as SearchStatus, h as DataTableProps, g as DataTableLabels, f as DataTableCopyActions, P as PasteMode, k as RowsPastePayload } from './types-Cs9MiZs1.js';
-export { C as ColumnFreezeColumnInput, a as ColumnFreezeEdgeSide, b as ColumnFreezeMeta, d as ColumnFreezeSide, D as DEFAULT_DATA_TABLE_LABELS, I as INLINE_SEARCH_MAX_RESULTS, S as SearchCorpusRow, p as buildColumnFreezeOffsets, q as buildFlatSearchCorpus, r as buildSearchMatchKey, s as buildSearchMatchKeys, t as buildTreeSearchCorpus, u as cellValueToSearchText, v as collectAncestorKeysToExpand, w as collectSearchMatchesInRange, x as createSearchRegex, y as escapeSearchRegex, z as formatSearchResultLabel, A as getColumnFreezeEdgeAttr, B as getColumnFreezeStyle, E as mapSearchResultToVisibleItem, F as mapSearchResultsToVisibleKeys, G as nextSearchIndex, H as nextSearchStride, J as previousSearchIndex, K as resolveColumnFreezeSide, L as resolveDataTableLabels } from './types-Cs9MiZs1.js';
-import { Row, ColumnDef, Table, Updater, RowSelectionState } from '@tanstack/react-table';
+import { W as CellEditType, c as CellRenderer, C as CellKind, a as CellRenderContext, i as DataTableClassNames, R as RowSelectionMode, g as ColumnFreezeOffset, p as SearchResultItem, q as SearchStatus, l as DataTableProps, k as DataTableLabels, j as DataTableCopyActions, P as PasteMode, o as RowsPastePayload } from './types-bgEceyRV.js';
+export { B as BuiltinCellKind, b as CellRenderFn, d as ColumnFreezeColumnInput, e as ColumnFreezeEdgeSide, f as ColumnFreezeMeta, h as ColumnFreezeSide, D as DEFAULT_DATA_TABLE_LABELS, I as INLINE_SEARCH_MAX_RESULTS, S as SearchCorpusRow, t as buildColumnFreezeOffsets, u as buildFlatSearchCorpus, v as buildSearchMatchKey, w as buildSearchMatchKeys, x as buildTreeSearchCorpus, y as cellValueToSearchText, z as collectAncestorKeysToExpand, A as collectSearchMatchesInRange, E as createSearchRegex, F as escapeSearchRegex, G as formatSearchResultLabel, H as getColumnFreezeEdgeAttr, J as getColumnFreezeStyle, K as mapSearchResultToVisibleItem, L as mapSearchResultsToVisibleKeys, M as nextSearchIndex, N as nextSearchStride, O as previousSearchIndex, Q as resolveColumnFreezeSide, U as resolveDataTableLabels, V as resolveHeaderFreezeOffset } from './types-bgEceyRV.js';
+import { Row, ColumnDef, CellContext, Table, Cell, Updater, RowSelectionState } from '@tanstack/react-table';
 export { ColumnDef, ColumnResizeMode, ColumnSizingState, RowSelectionState } from '@tanstack/react-table';
 import { Virtualizer, VirtualItem } from '@tanstack/react-virtual';
 import * as react from 'react';
@@ -36,6 +36,12 @@ declare function getCellEditDraftValue(value: unknown): string;
 /** Returns updated data on success; null if parsing fails or the cell is not editable */
 declare function applyCellEdit<T extends Record<string, unknown>>(data: T[], rows: Row<T>[], rowIndex: number, colIndex: number, raw: string): T[] | null;
 
+type CellRendererRegistry = Map<string, CellRenderer>;
+/** Later entries with the same `kind` override earlier ones (including builtins). */
+declare function createCellRendererRegistry(customRenderers?: readonly CellRenderer[]): CellRendererRegistry;
+declare function resolveCellRenderer<T extends Record<string, unknown>>(registry: CellRendererRegistry, kind: CellKind | undefined, ctx: CellRenderContext<T>): CellRenderer | undefined;
+declare function formatDefaultCellValue(value: unknown): string | null;
+
 type CellPosition = {
     row: number;
     col: number;
@@ -164,6 +170,10 @@ type DataTableRowContextValue = {
         onCommitEdit: (raw?: string) => boolean;
         onCancelEdit: () => void;
     };
+    cellRender: {
+        registry: CellRendererRegistry;
+        commitValue: (rowId: string, columnId: string, value: unknown) => boolean;
+    };
     expand: {
         enableExpand: boolean;
         toggleField?: string;
@@ -187,6 +197,19 @@ type DataTableRowContextValue = {
     };
 };
 
+/**
+ * TanStack `CellContext` with a guaranteed `update` commit helper.
+ * Prefer this over bare `cell.getContext()`, which does not include `update` at runtime.
+ */
+type CellContextWithUpdate<TData, TValue> = CellContext<TData, TValue> & {
+    update: (next: TValue) => void;
+};
+/**
+ * Injects `update` into a TanStack `CellContext` so `ColumnDef.cell` can commit
+ * through `onCellChange` / `onDataChange` the same way compound `Column.render` does.
+ */
+declare function withCellUpdate<TData extends Record<string, unknown>, TValue>(context: CellContext<TData, TValue>, commitValue: (rowId: string, columnId: string, value: unknown) => boolean): CellContextWithUpdate<TData, TValue>;
+
 type UseInlineSearchOptions = {
     enabled?: boolean;
     rowCount: number;
@@ -248,6 +271,11 @@ type UseGlideTableResult<T extends Record<string, unknown>> = {
     paddingTop: number;
     paddingBottom: number;
     rowContextValue: DataTableRowContextValue;
+    /**
+     * TanStack `CellContext` with `update` injected for custom `ColumnDef.cell` renders.
+     * Prefer this over `cell.getContext()` when calling `flexRender` yourself.
+     */
+    getCellContext: <TValue>(cell: Cell<T, TValue>) => CellContextWithUpdate<T, TValue>;
     handleToggleSelect: (row: Row<T>) => void;
     clearHover: () => void;
     copySelection: DataTableCopyActions["copySelection"];
@@ -284,6 +312,27 @@ declare function useCellEdit<T extends Record<string, unknown>>({ data, rows, on
     cancelEdit: () => void;
 };
 
+declare const BUILTIN_CELL_RENDERERS: CellRenderer[];
+
+type CommitCellValueOptions<T extends Record<string, unknown>> = {
+    data: T[];
+    rows: Row<T>[];
+    rowId: string;
+    columnId: string;
+    value: unknown;
+    onCellChange?: (rowId: string, columnId: string, value: unknown) => void;
+    onDataChange?: (data: T[]) => void;
+};
+/**
+ * Shared commit path for custom `render` updates and built-in cell kinds.
+ * Prefers `onCellChange`; falls back to immutable `onDataChange` patch.
+ */
+declare function commitCellValue<T extends Record<string, unknown>>({ data, rows, rowId, columnId, value, onCellChange, onDataChange, }: CommitCellValueOptions<T>): boolean;
+
+declare function ResolvedTableCell<T extends Record<string, unknown>>({ info, }: {
+    info: CellContext<T, unknown>;
+}): react.ReactNode;
+
 /** Width styles for header/body cells when column sizing is active. */
 declare function getColumnSizeStyle(size: number, options?: {
     force?: boolean;
@@ -350,6 +399,11 @@ type CopyRowEntry<T extends Record<string, unknown>> = {
     /** Tree depth relative to the table root (0 = top-level). */
     depth: number;
 };
+/**
+ * Clipboard / Excel paste expects one plain string per cell.
+ * Avoids `String(object)` → `[object Object]` and joins arrays with `, `.
+ */
+declare function formatCellValue(value: unknown): string;
 declare function flattenSubtreeRows<T extends Record<string, unknown>>(row: T): T[];
 /**
  * Collects copy rows with tree depth so paste can rebuild parent/child nesting.
@@ -409,4 +463,4 @@ declare const useConvertTreeData: <T extends Record<string, unknown>>({ data, en
 declare function resolveRowSelection(mode: RowSelectionMode, controlledSelection: RowSelectionState | undefined, internalSelection: RowSelectionState): RowSelectionState;
 declare function applySelectionUpdater(mode: RowSelectionMode, updater: Updater<RowSelectionState>, previous: RowSelectionState): RowSelectionState;
 
-export { CELL_SELECTION_EDGES_CLASS, type CellSelectionBounds, ColumnFreezeOffset, type ColumnRowSpanMap, type CopyRowEntry, type CopySelectionMode, DEFAULT_TREE_CHILDREN_FIELD, DEFAULT_TREE_ID_FIELD, DEFAULT_TREE_PARENT_ID_FIELD, DEFAULT_TREE_QTY_FIELD, DataTableCopyActions, DataTableLabels, DataTableProps, type DragState, type EditingCell, PasteMode, RowSelectionMode, type RowSpanInfo, RowsPastePayload, SearchResultItem, SearchStatus, type TreeRow, type UseConvertTreeDataParams, type UseGlideTableOptions, type UseGlideTableResult, type UseInlineSearchOptions, type UseInlineSearchResult, applyCellEdit, applyFillData, applySelectionUpdater, buildColumnRowSpanMap, buildRowsPastePayload, canExpandRow, collectCopyRowEntries, collectCopyRows, collectFillChanges, collectRowSpanColumns, flattenSubtreeRows, getCellEditDraftValue, getCellSelectionEdgeStyle, getColumnEditType, getColumnSizeStyle, getRowIndexInMergedCell, hasCellSelectionEdges, isCellInSelection, isColumnEditable, isEditablePasteTarget, measureMergedSpanRowHeights, parseCellEditValue, parseClipboardTSV, parseClipboardTSVWithDepths, resolvePasteColumnIds, resolveRowSelection, resolveRowSpanAt, rowRangeToHeightRatios, serializeCopyRowsToTSV, serializeSelectionToTSV, toggleExpandedRowId, useCellEdit, useCellSelection, useConvertTreeData, useGlideTable, useInlineSearch, writeSelectionToClipboard };
+export { BUILTIN_CELL_RENDERERS, CELL_SELECTION_EDGES_CLASS, type CellContextWithUpdate, CellKind, CellRenderContext, CellRenderer, type CellRendererRegistry, type CellSelectionBounds, ColumnFreezeOffset, type ColumnRowSpanMap, type CopyRowEntry, type CopySelectionMode, DEFAULT_TREE_CHILDREN_FIELD, DEFAULT_TREE_ID_FIELD, DEFAULT_TREE_PARENT_ID_FIELD, DEFAULT_TREE_QTY_FIELD, DataTableCopyActions, DataTableLabels, DataTableProps, type DragState, type EditingCell, PasteMode, ResolvedTableCell, RowSelectionMode, type RowSpanInfo, RowsPastePayload, SearchResultItem, SearchStatus, type TreeRow, type UseConvertTreeDataParams, type UseGlideTableOptions, type UseGlideTableResult, type UseInlineSearchOptions, type UseInlineSearchResult, applyCellEdit, applyFillData, applySelectionUpdater, buildColumnRowSpanMap, buildRowsPastePayload, canExpandRow, collectCopyRowEntries, collectCopyRows, collectFillChanges, collectRowSpanColumns, commitCellValue, createCellRendererRegistry, flattenSubtreeRows, formatCellValue, formatDefaultCellValue, getCellEditDraftValue, getCellSelectionEdgeStyle, getColumnEditType, getColumnSizeStyle, getRowIndexInMergedCell, hasCellSelectionEdges, isCellInSelection, isColumnEditable, isEditablePasteTarget, measureMergedSpanRowHeights, parseCellEditValue, parseClipboardTSV, parseClipboardTSVWithDepths, resolveCellRenderer, resolvePasteColumnIds, resolveRowSelection, resolveRowSpanAt, rowRangeToHeightRatios, serializeCopyRowsToTSV, serializeSelectionToTSV, toggleExpandedRowId, useCellEdit, useCellSelection, useConvertTreeData, useGlideTable, useInlineSearch, withCellUpdate, writeSelectionToClipboard };