bolt-table 0.1.25 → 0.1.27

package/dist/index.d.mts

@@ -19,10 +19,13 @@ interface BoltTableIcons {
     chevronsRight?: React$1.ReactNode;
     copy?: React$1.ReactNode;
     edit?: React$1.ReactNode;
+    search?: React$1.ReactNode;
+    columns?: React$1.ReactNode;
+    close?: React$1.ReactNode;
 }
 
 /** `'asc'` | `'desc'` | `null` — the direction of a column sort. */
-type SortDirection = 'asc' | 'desc' | null;
+type SortDirection = "asc" | "desc" | null;
 /** Defines the shape of a single column in BoltTable. */
 interface ColumnType<T = unknown> {
     /** The text or React node shown in the column header. */
@@ -54,11 +57,11 @@ interface ColumnType<T = unknown> {
     /** Whether this column is hidden by default on first render. */
     defaultHidden?: boolean;
     /** Which side this column is pinned to by default: `'left'`, `'right'`, or `false`. */
-    defaultPinned?: 'left' | 'right' | false;
+    defaultPinned?: "left" | "right" | false;
     /** Controlled hidden state of the column. For uncontrolled, use `defaultHidden`. */
     hidden?: boolean;
     /** Controlled pinned state: `'left'`, `'right'`, or `false`. For uncontrolled, use `defaultPinned`. */
-    pinned?: 'left' | 'right' | false;
+    pinned?: "left" | "right" | false;
     /** Additional CSS class name(s) applied to every cell in this column. */
     className?: string;
     /** Inline CSS styles applied to every cell in this column. */
@@ -108,7 +111,7 @@ interface ColumnContextMenuItem {
     onClick: (columnKey: string) => void;
 }
 /** How the row selection was triggered: `'all'`, `'single'`, or `'multiple'`. */
-type RowSelectMethod = 'all' | 'single' | 'multiple';
+type RowSelectMethod = "all" | "single" | "multiple";
 /** Configuration for expandable rows with a custom rendered panel below each row. */
 interface ExpandableConfig<T = unknown> {
     /** When `true`, all rows are expanded on initial render. */
@@ -129,7 +132,7 @@ interface ExpandableConfig<T = unknown> {
 /** Configuration for row selection (checkboxes or radio buttons). */
 interface RowSelectionConfig<T = unknown> {
     /** `'checkbox'` for multi-select (default) or `'radio'` for single-select. */
-    type?: 'checkbox' | 'radio';
+    type?: "checkbox" | "radio";
     /** When `true`, hides the "select all" checkbox in the header. */
     hideSelectAll?: boolean;
     /** The currently selected row keys (controlled). */
@@ -171,6 +174,19 @@ interface RowPinningConfig {
 }
 /** Base type for row records — all row objects must be indexable by string keys. */
 type DataRecord = Record<string, unknown>;
+/** Configuration for persisting column state to localStorage. */
+interface ColumnPersistenceConfig {
+    /** Unique key used as the localStorage key prefix. Required. */
+    storageKey: string;
+    /** Persist column order. Defaults to `true`. */
+    persistOrder?: boolean;
+    /** Persist column widths. Defaults to `true`. */
+    persistWidths?: boolean;
+    /** Persist column visibility (hidden state). Defaults to `true`. */
+    persistVisibility?: boolean;
+    /** Persist column pinned state. Defaults to `true`. */
+    persistPinned?: boolean;
+}
 
 interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Column definitions controlling what columns are shown, their order, width, pinning, sort/filter, and rendering. */
@@ -206,7 +222,7 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Called after the user drops a column header into a new position. */
     readonly onColumnOrderChange?: (newOrder: string[]) => void;
     /** Called when the user pins or unpins a column via the context menu. */
-    readonly onColumnPin?: (columnKey: string, pinned: 'left' | 'right' | false) => void;
+    readonly onColumnPin?: (columnKey: string, pinned: "left" | "right" | false) => void;
     /** Called when the user hides or shows a column via the context menu. */
     readonly onColumnHide?: (columnKey: string, hidden: boolean) => void;
     /** Determines the unique key for each row. Can be a string property name, function, number, or symbol. */
@@ -218,7 +234,7 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Row pinning configuration. Pass `true` for internal state management, or an object for controlled mode. */
     readonly rowPinning?: RowPinningConfig | boolean;
     /** Called when the user pins or unpins a row via the cell context menu. */
-    readonly onRowPin?: (rowKey: React$1.Key, pinned: 'top' | 'bottom' | false) => void;
+    readonly onRowPin?: (rowKey: React$1.Key, pinned: "top" | "bottom" | false) => void;
     /** Called when the user scrolls near the bottom of the table. Use for infinite scroll. */
     readonly onEndReached?: () => void;
     /** How many rows from the end of the list should trigger onEndReached. */
@@ -251,6 +267,20 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     readonly onEdit?: (value: unknown, record: T, dataIndex: string, rowIndex: number) => void;
     /** Called when a row is clicked. When provided, all row cells show a pointer cursor on hover. */
     readonly onRowClick?: (record: T, index: number, event: React$1.MouseEvent) => void;
+    /** Enable horizontal virtualization for tables with many columns. Only visible columns are rendered. */
+    readonly enableColumnVirtualization?: boolean;
+    /** Enable dynamic row heights based on content. Uses ResizeObserver to measure actual row heights. */
+    readonly enableDynamicRowHeight?: boolean;
+    /** Configuration for persisting column state (order, widths, visibility, pinned) to localStorage. Defaults to `false` (disabled). */
+    readonly columnPersistence?: ColumnPersistenceConfig | false;
+    /** Show the column picker/settings button in the header area. Defaults to `true`. */
+    readonly showColumnSettings?: boolean;
+    /** Hide the global search input above the table. Defaults to `false`. */
+    readonly hideGlobalSearch?: boolean;
+    /** Controlled global search value. When provided, the table uses this instead of its own internal state. */
+    readonly globalSearchValue?: string;
+    /** Called when the global search value changes. */
+    readonly onGlobalSearchChange?: (value: string) => void;
 }
 interface ClassNamesTypes {
     /** Applied to all non-pinned column header cells. */
@@ -318,7 +348,7 @@ interface StylesTypes {
     /** Inline styles for the "X–Y of Z" info text. */
     paginationInfo?: CSSProperties;
 }
-declare function BoltTable<T extends DataRecord = DataRecord>({ columns: rawInitialColumns, data: rawData, rowHeight, expandedRowHeight, maxExpandedRowHeight, accentColor, className, classNames, styles, gripIcon, hideGripIcon, icons, pagination, onPaginationChange, onColumnResize, onColumnOrderChange, onColumnPin, onColumnHide, rowSelection, rowPinning, onRowPin, expandable, rowKey, onEndReached, onEndReachedThreshold, isLoading, onSortChange, onFilterChange, columnContextMenuItems, autoHeight, layoutLoading, emptyRenderer, rowClassName, rowStyle, disabledFilters, onCopy, keepPinnedRowsAcrossPages, onEdit, onRowClick, }: BoltTableProps<T>): react_jsx_runtime.JSX.Element;
+declare function BoltTable<T extends DataRecord = DataRecord>({ columns: rawInitialColumns, data: rawData, rowHeight, expandedRowHeight, maxExpandedRowHeight, accentColor, className, classNames, styles, gripIcon, hideGripIcon, icons, pagination, onPaginationChange, onColumnResize, onColumnOrderChange, onColumnPin, onColumnHide, rowSelection, rowPinning, onRowPin, expandable, rowKey, onEndReached, onEndReachedThreshold, isLoading, onSortChange, onFilterChange, columnContextMenuItems, autoHeight, layoutLoading, emptyRenderer, rowClassName, rowStyle, disabledFilters, onCopy, keepPinnedRowsAcrossPages, onEdit, onRowClick, enableColumnVirtualization, enableDynamicRowHeight, columnPersistence, showColumnSettings, hideGlobalSearch, globalSearchValue, onGlobalSearchChange, }: BoltTableProps<T>): react_jsx_runtime.JSX.Element;
 
 interface DraggableHeaderProps {
     /** Column definition for this header cell. */
@@ -449,7 +479,11 @@ interface TableBodyProps {
     } | null;
     /** Called when the editing input commits or cancels — clears `editingCell`. */
     onEditComplete?: () => void;
+    /** When true, rows use content-based heights measured by ResizeObserver. */
+    enableDynamicRowHeight?: boolean;
+    /** Called when a row's measured height changes. Used by the parent to update the virtualizer. */
+    onRowHeightChange?: (index: number, height: number) => void;
 }
 declare const TableBody: React$1.FC<TableBodyProps>;
 
-export { BoltTable, type BoltTableIcons, type CellContextMenuItem, type ClassNamesTypes, type ColumnContextMenuItem, type ColumnType, type DataRecord, DraggableHeader, type ExpandableConfig, type PaginationType, ResizeOverlay, type RowPinningConfig, type RowSelectionConfig, type SortDirection, type StylesTypes, TableBody };
+export { BoltTable, type BoltTableIcons, type CellContextMenuItem, type ClassNamesTypes, type ColumnContextMenuItem, type ColumnPersistenceConfig, type ColumnType, type DataRecord, DraggableHeader, type ExpandableConfig, type PaginationType, ResizeOverlay, type RowPinningConfig, type RowSelectionConfig, type SortDirection, type StylesTypes, TableBody };

package/dist/index.d.ts

@@ -19,10 +19,13 @@ interface BoltTableIcons {
     chevronsRight?: React$1.ReactNode;
     copy?: React$1.ReactNode;
     edit?: React$1.ReactNode;
+    search?: React$1.ReactNode;
+    columns?: React$1.ReactNode;
+    close?: React$1.ReactNode;
 }
 
 /** `'asc'` | `'desc'` | `null` — the direction of a column sort. */
-type SortDirection = 'asc' | 'desc' | null;
+type SortDirection = "asc" | "desc" | null;
 /** Defines the shape of a single column in BoltTable. */
 interface ColumnType<T = unknown> {
     /** The text or React node shown in the column header. */
@@ -54,11 +57,11 @@ interface ColumnType<T = unknown> {
     /** Whether this column is hidden by default on first render. */
     defaultHidden?: boolean;
     /** Which side this column is pinned to by default: `'left'`, `'right'`, or `false`. */
-    defaultPinned?: 'left' | 'right' | false;
+    defaultPinned?: "left" | "right" | false;
     /** Controlled hidden state of the column. For uncontrolled, use `defaultHidden`. */
     hidden?: boolean;
     /** Controlled pinned state: `'left'`, `'right'`, or `false`. For uncontrolled, use `defaultPinned`. */
-    pinned?: 'left' | 'right' | false;
+    pinned?: "left" | "right" | false;
     /** Additional CSS class name(s) applied to every cell in this column. */
     className?: string;
     /** Inline CSS styles applied to every cell in this column. */
@@ -108,7 +111,7 @@ interface ColumnContextMenuItem {
     onClick: (columnKey: string) => void;
 }
 /** How the row selection was triggered: `'all'`, `'single'`, or `'multiple'`. */
-type RowSelectMethod = 'all' | 'single' | 'multiple';
+type RowSelectMethod = "all" | "single" | "multiple";
 /** Configuration for expandable rows with a custom rendered panel below each row. */
 interface ExpandableConfig<T = unknown> {
     /** When `true`, all rows are expanded on initial render. */
@@ -129,7 +132,7 @@ interface ExpandableConfig<T = unknown> {
 /** Configuration for row selection (checkboxes or radio buttons). */
 interface RowSelectionConfig<T = unknown> {
     /** `'checkbox'` for multi-select (default) or `'radio'` for single-select. */
-    type?: 'checkbox' | 'radio';
+    type?: "checkbox" | "radio";
     /** When `true`, hides the "select all" checkbox in the header. */
     hideSelectAll?: boolean;
     /** The currently selected row keys (controlled). */
@@ -171,6 +174,19 @@ interface RowPinningConfig {
 }
 /** Base type for row records — all row objects must be indexable by string keys. */
 type DataRecord = Record<string, unknown>;
+/** Configuration for persisting column state to localStorage. */
+interface ColumnPersistenceConfig {
+    /** Unique key used as the localStorage key prefix. Required. */
+    storageKey: string;
+    /** Persist column order. Defaults to `true`. */
+    persistOrder?: boolean;
+    /** Persist column widths. Defaults to `true`. */
+    persistWidths?: boolean;
+    /** Persist column visibility (hidden state). Defaults to `true`. */
+    persistVisibility?: boolean;
+    /** Persist column pinned state. Defaults to `true`. */
+    persistPinned?: boolean;
+}
 
 interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Column definitions controlling what columns are shown, their order, width, pinning, sort/filter, and rendering. */
@@ -206,7 +222,7 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Called after the user drops a column header into a new position. */
     readonly onColumnOrderChange?: (newOrder: string[]) => void;
     /** Called when the user pins or unpins a column via the context menu. */
-    readonly onColumnPin?: (columnKey: string, pinned: 'left' | 'right' | false) => void;
+    readonly onColumnPin?: (columnKey: string, pinned: "left" | "right" | false) => void;
     /** Called when the user hides or shows a column via the context menu. */
     readonly onColumnHide?: (columnKey: string, hidden: boolean) => void;
     /** Determines the unique key for each row. Can be a string property name, function, number, or symbol. */
@@ -218,7 +234,7 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     /** Row pinning configuration. Pass `true` for internal state management, or an object for controlled mode. */
     readonly rowPinning?: RowPinningConfig | boolean;
     /** Called when the user pins or unpins a row via the cell context menu. */
-    readonly onRowPin?: (rowKey: React$1.Key, pinned: 'top' | 'bottom' | false) => void;
+    readonly onRowPin?: (rowKey: React$1.Key, pinned: "top" | "bottom" | false) => void;
     /** Called when the user scrolls near the bottom of the table. Use for infinite scroll. */
     readonly onEndReached?: () => void;
     /** How many rows from the end of the list should trigger onEndReached. */
@@ -251,6 +267,20 @@ interface BoltTableProps<T extends DataRecord = DataRecord> {
     readonly onEdit?: (value: unknown, record: T, dataIndex: string, rowIndex: number) => void;
     /** Called when a row is clicked. When provided, all row cells show a pointer cursor on hover. */
     readonly onRowClick?: (record: T, index: number, event: React$1.MouseEvent) => void;
+    /** Enable horizontal virtualization for tables with many columns. Only visible columns are rendered. */
+    readonly enableColumnVirtualization?: boolean;
+    /** Enable dynamic row heights based on content. Uses ResizeObserver to measure actual row heights. */
+    readonly enableDynamicRowHeight?: boolean;
+    /** Configuration for persisting column state (order, widths, visibility, pinned) to localStorage. Defaults to `false` (disabled). */
+    readonly columnPersistence?: ColumnPersistenceConfig | false;
+    /** Show the column picker/settings button in the header area. Defaults to `true`. */
+    readonly showColumnSettings?: boolean;
+    /** Hide the global search input above the table. Defaults to `false`. */
+    readonly hideGlobalSearch?: boolean;
+    /** Controlled global search value. When provided, the table uses this instead of its own internal state. */
+    readonly globalSearchValue?: string;
+    /** Called when the global search value changes. */
+    readonly onGlobalSearchChange?: (value: string) => void;
 }
 interface ClassNamesTypes {
     /** Applied to all non-pinned column header cells. */
@@ -318,7 +348,7 @@ interface StylesTypes {
     /** Inline styles for the "X–Y of Z" info text. */
     paginationInfo?: CSSProperties;
 }
-declare function BoltTable<T extends DataRecord = DataRecord>({ columns: rawInitialColumns, data: rawData, rowHeight, expandedRowHeight, maxExpandedRowHeight, accentColor, className, classNames, styles, gripIcon, hideGripIcon, icons, pagination, onPaginationChange, onColumnResize, onColumnOrderChange, onColumnPin, onColumnHide, rowSelection, rowPinning, onRowPin, expandable, rowKey, onEndReached, onEndReachedThreshold, isLoading, onSortChange, onFilterChange, columnContextMenuItems, autoHeight, layoutLoading, emptyRenderer, rowClassName, rowStyle, disabledFilters, onCopy, keepPinnedRowsAcrossPages, onEdit, onRowClick, }: BoltTableProps<T>): react_jsx_runtime.JSX.Element;
+declare function BoltTable<T extends DataRecord = DataRecord>({ columns: rawInitialColumns, data: rawData, rowHeight, expandedRowHeight, maxExpandedRowHeight, accentColor, className, classNames, styles, gripIcon, hideGripIcon, icons, pagination, onPaginationChange, onColumnResize, onColumnOrderChange, onColumnPin, onColumnHide, rowSelection, rowPinning, onRowPin, expandable, rowKey, onEndReached, onEndReachedThreshold, isLoading, onSortChange, onFilterChange, columnContextMenuItems, autoHeight, layoutLoading, emptyRenderer, rowClassName, rowStyle, disabledFilters, onCopy, keepPinnedRowsAcrossPages, onEdit, onRowClick, enableColumnVirtualization, enableDynamicRowHeight, columnPersistence, showColumnSettings, hideGlobalSearch, globalSearchValue, onGlobalSearchChange, }: BoltTableProps<T>): react_jsx_runtime.JSX.Element;
 
 interface DraggableHeaderProps {
     /** Column definition for this header cell. */
@@ -449,7 +479,11 @@ interface TableBodyProps {
     } | null;
     /** Called when the editing input commits or cancels — clears `editingCell`. */
     onEditComplete?: () => void;
+    /** When true, rows use content-based heights measured by ResizeObserver. */
+    enableDynamicRowHeight?: boolean;
+    /** Called when a row's measured height changes. Used by the parent to update the virtualizer. */
+    onRowHeightChange?: (index: number, height: number) => void;
 }
 declare const TableBody: React$1.FC<TableBodyProps>;
 
-export { BoltTable, type BoltTableIcons, type CellContextMenuItem, type ClassNamesTypes, type ColumnContextMenuItem, type ColumnType, type DataRecord, DraggableHeader, type ExpandableConfig, type PaginationType, ResizeOverlay, type RowPinningConfig, type RowSelectionConfig, type SortDirection, type StylesTypes, TableBody };
+export { BoltTable, type BoltTableIcons, type CellContextMenuItem, type ClassNamesTypes, type ColumnContextMenuItem, type ColumnPersistenceConfig, type ColumnType, type DataRecord, DraggableHeader, type ExpandableConfig, type PaginationType, ResizeOverlay, type RowPinningConfig, type RowSelectionConfig, type SortDirection, type StylesTypes, TableBody };