react-glide-table 1.4.1 → 1.7.0

package/dist/{types-CHQnBz91.d.cts → types-Cs9MiZs1.d.cts}

@@ -46,8 +46,70 @@ declare function buildColumnFreezeOffsets(columns: ColumnFreezeColumnInput[]): M
 /** Sticky position styles for a frozen header or body cell. */
 declare function getColumnFreezeStyle(offset: ColumnFreezeOffset | undefined, options?: {
     isHeader?: boolean;
+    headerTop?: number;
 }): CSSProperties | undefined;
 
+/** Cell match as `[colIndex, rowIndex]` — same order as Glide Data Grid `Item`.
+ * For tree tables, `rowIndex` is the search-corpus index (includes collapsed rows).
+ */
+type SearchResultItem = readonly [colIndex: number, rowIndex: number];
+type SearchStatus = {
+    rowsSearched: number;
+    results: number;
+    selectedIndex: number;
+};
+/** One searchable row, including collapsed tree descendants. */
+type SearchCorpusRow<T extends Record<string, unknown> = Record<string, unknown>> = {
+    /** Stable row id used to resolve the visible index after expand */
+    id: string;
+    data: T;
+    /**
+     * Toggle-field keys of ancestors that must be in `expandedRows`
+     * for this row to become visible.
+     */
+    ancestorToggleKeys: string[];
+};
+declare const INLINE_SEARCH_MAX_RESULTS = 1000;
+declare function escapeSearchRegex(value: string): string;
+declare function createSearchRegex(query: string): RegExp | null;
+declare function cellValueToSearchText(value: unknown): string | undefined;
+declare function formatSearchResultLabel(status: SearchStatus): string;
+declare function nextSearchIndex(selectedIndex: number, results: number): number;
+declare function previousSearchIndex(selectedIndex: number, results: number): number;
+declare function buildSearchMatchKey(colIndex: number, rowIndex: number): string;
+declare function buildSearchMatchKeys(results: readonly SearchResultItem[]): Set<string>;
+/**
+ * Scan a contiguous row window for matches.
+ * Returns newly found items (appended in row-major, col-major order).
+ */
+declare function collectSearchMatchesInRange(options: {
+    query: string;
+    startRow: number;
+    rowCount: number;
+    columnCount: number;
+    getCellValue: (rowIndex: number, colIndex: number) => unknown;
+    maxResults?: number;
+}): SearchResultItem[];
+declare function nextSearchStride(currentStride: number, elapsedMs: number, targetMs?: number): number;
+/**
+ * Flat (non-tree) search corpus — one entry per visible row.
+ */
+declare function buildFlatSearchCorpus<T extends Record<string, unknown>>(rows: T[], getRowId: (row: T, index: number) => string): SearchCorpusRow<T>[];
+/**
+ * Build a search corpus that includes collapsed tree descendants.
+ * Starts from root rows (`level === 0`) and walks each node's `children`.
+ */
+declare function buildTreeSearchCorpus<T extends Record<string, unknown>>(visibleRows: T[], options: {
+    toggleField: string;
+    getRowId: (row: T, index: number) => string;
+}): SearchCorpusRow<T>[];
+/**
+ * Map corpus-indexed search results onto currently visible row indices for highlighting.
+ */
+declare function mapSearchResultsToVisibleKeys(results: readonly SearchResultItem[], corpus: readonly SearchCorpusRow[], visibleRowIndexById: Map<string, number>): Set<string>;
+declare function mapSearchResultToVisibleItem(item: SearchResultItem, corpus: readonly SearchCorpusRow[], visibleRowIndexById: Map<string, number>): SearchResultItem | null;
+declare function collectAncestorKeysToExpand(corpusRow: SearchCorpusRow, expandedRows: Set<string>): string[];
+
 type DataTableLabels = {
     empty: string;
     loading: string;
@@ -56,6 +118,12 @@ type DataTableLabels = {
     collapseRow: string;
     /** Accessible label for the column resize handle */
     resizeColumn: string;
+    /** Built-in find-in-page search overlay */
+    searchPlaceholder: string;
+    searchResultHint: string;
+    searchPrevious: string;
+    searchNext: string;
+    searchClose: string;
 };
 /** Default copy. Override via the `labels` option. */
 declare const DEFAULT_DATA_TABLE_LABELS: DataTableLabels;
@@ -254,6 +322,25 @@ type DataTableProps<T extends Record<string, unknown>> = {
      * Does not reorder columns; offsets stack so frozen cells do not overlap.
      */
     enableColumnFreeze?: boolean;
+    /**
+     * Enable Glide-style built-in find-in-page search (Ctrl/Cmd+F).
+     * Highlights matching cells; Enter / buttons navigate without filtering rows.
+     * Defaults to false.
+     */
+    enableInlineSearch?: boolean;
+    /** Controlled search overlay visibility. When omitted, Ctrl/Cmd+F toggles internally. */
+    showSearch?: boolean;
+    /** Controlled search query string. */
+    searchValue?: string;
+    onSearchValueChange?: (value: string) => void;
+    /**
+     * Emitted when the overlay close control is used (X / Escape / Ctrl+F in the box).
+     * Providing this shows the close button. For controlled `showSearch`, set it false here.
+     */
+    onSearchClose?: () => void;
+    /** Override the internal match list (`[colIndex, rowIndex]`). */
+    searchResults?: readonly SearchResultItem[];
+    onSearchResultsChanged?: (results: readonly SearchResultItem[], navIndex: number) => void;
     /**
      * Optional UI part replacements for the unstyled DataTable renderer.
      * Use with `createTable` / `Table.Column`, or pass columns directly to `DataTable`.
@@ -295,6 +382,12 @@ type DataTableClassNames = {
     expandToggle?: string;
     expandToggleIcon?: string;
     fillHandle?: string;
+    /** Built-in search overlay root */
+    search?: string;
+    searchInput?: string;
+    searchButton?: string;
+    searchStatus?: string;
+    searchProgress?: string;
 };
 type DataTableToolbarSlotProps = {
     filteredCount?: number;
@@ -386,8 +479,18 @@ type TableColumnProps<T extends Record<string, unknown>, K extends string = keyo
     headerClassName?: string;
     render?: (value: K extends keyof T ? T[K] : unknown, row: Row<T>, index: number) => ReactNode;
 };
+/** Declares a multi-row header group wrapping leaf `Table.Column`s. */
+type TableColumnGroupProps = {
+    /** Group header label shown in the top header row */
+    header: ReactNode;
+    children: ReactNode;
+    /** Stable group id. Auto-generated when omitted */
+    id?: string;
+    align?: "left" | "center" | "right";
+    headerClassName?: string;
+};
 type TableProps<T extends Record<string, unknown>> = Omit<DataTableProps<T>, "columns"> & {
     children: ReactNode;
 };
 
-export { type ColumnFreezeColumnInput as C, DEFAULT_DATA_TABLE_LABELS as D, type PasteMode as P, type RowSelectionMode as R, type TableColumnProps as T, type ColumnFreezeEdgeSide as a, type ColumnFreezeMeta as b, type ColumnFreezeOffset as c, type ColumnFreezeSide as d, type DataTableClassNames as e, type DataTableCopyActions as f, type DataTableLabels as g, type DataTableProps as h, type DataTableScrollSlotProps as i, type DataTableSlots as j, type RowsPastePayload as k, type TableProps as l, buildColumnFreezeOffsets as m, getColumnFreezeEdgeAttr as n, getColumnFreezeStyle as o, resolveDataTableLabels as p, type CellEditType as q, resolveColumnFreezeSide as r };
+export { getColumnFreezeEdgeAttr as A, getColumnFreezeStyle as B, type ColumnFreezeColumnInput as C, DEFAULT_DATA_TABLE_LABELS as D, mapSearchResultToVisibleItem as E, mapSearchResultsToVisibleKeys as F, nextSearchIndex as G, nextSearchStride as H, INLINE_SEARCH_MAX_RESULTS as I, previousSearchIndex as J, resolveColumnFreezeSide as K, resolveDataTableLabels as L, type CellEditType as M, type PasteMode as P, type RowSelectionMode as R, type SearchCorpusRow as S, type TableColumnGroupProps as T, type ColumnFreezeEdgeSide as a, type ColumnFreezeMeta as b, type ColumnFreezeOffset as c, type ColumnFreezeSide as d, type DataTableClassNames as e, type DataTableCopyActions as f, type DataTableLabels as g, type DataTableProps as h, type DataTableScrollSlotProps as i, type DataTableSlots as j, type RowsPastePayload as k, type SearchResultItem as l, type SearchStatus as m, type TableColumnProps as n, type TableProps as o, buildColumnFreezeOffsets as p, buildFlatSearchCorpus as q, buildSearchMatchKey as r, buildSearchMatchKeys as s, buildTreeSearchCorpus as t, cellValueToSearchText as u, collectAncestorKeysToExpand as v, collectSearchMatchesInRange as w, createSearchRegex as x, escapeSearchRegex as y, formatSearchResultLabel as z };

package/dist/{types-CHQnBz91.d.ts → types-Cs9MiZs1.d.ts}

@@ -46,8 +46,70 @@ declare function buildColumnFreezeOffsets(columns: ColumnFreezeColumnInput[]): M
 /** Sticky position styles for a frozen header or body cell. */
 declare function getColumnFreezeStyle(offset: ColumnFreezeOffset | undefined, options?: {
     isHeader?: boolean;
+    headerTop?: number;
 }): CSSProperties | undefined;
 
+/** Cell match as `[colIndex, rowIndex]` — same order as Glide Data Grid `Item`.
+ * For tree tables, `rowIndex` is the search-corpus index (includes collapsed rows).
+ */
+type SearchResultItem = readonly [colIndex: number, rowIndex: number];
+type SearchStatus = {
+    rowsSearched: number;
+    results: number;
+    selectedIndex: number;
+};
+/** One searchable row, including collapsed tree descendants. */
+type SearchCorpusRow<T extends Record<string, unknown> = Record<string, unknown>> = {
+    /** Stable row id used to resolve the visible index after expand */
+    id: string;
+    data: T;
+    /**
+     * Toggle-field keys of ancestors that must be in `expandedRows`
+     * for this row to become visible.
+     */
+    ancestorToggleKeys: string[];
+};
+declare const INLINE_SEARCH_MAX_RESULTS = 1000;
+declare function escapeSearchRegex(value: string): string;
+declare function createSearchRegex(query: string): RegExp | null;
+declare function cellValueToSearchText(value: unknown): string | undefined;
+declare function formatSearchResultLabel(status: SearchStatus): string;
+declare function nextSearchIndex(selectedIndex: number, results: number): number;
+declare function previousSearchIndex(selectedIndex: number, results: number): number;
+declare function buildSearchMatchKey(colIndex: number, rowIndex: number): string;
+declare function buildSearchMatchKeys(results: readonly SearchResultItem[]): Set<string>;
+/**
+ * Scan a contiguous row window for matches.
+ * Returns newly found items (appended in row-major, col-major order).
+ */
+declare function collectSearchMatchesInRange(options: {
+    query: string;
+    startRow: number;
+    rowCount: number;
+    columnCount: number;
+    getCellValue: (rowIndex: number, colIndex: number) => unknown;
+    maxResults?: number;
+}): SearchResultItem[];
+declare function nextSearchStride(currentStride: number, elapsedMs: number, targetMs?: number): number;
+/**
+ * Flat (non-tree) search corpus — one entry per visible row.
+ */
+declare function buildFlatSearchCorpus<T extends Record<string, unknown>>(rows: T[], getRowId: (row: T, index: number) => string): SearchCorpusRow<T>[];
+/**
+ * Build a search corpus that includes collapsed tree descendants.
+ * Starts from root rows (`level === 0`) and walks each node's `children`.
+ */
+declare function buildTreeSearchCorpus<T extends Record<string, unknown>>(visibleRows: T[], options: {
+    toggleField: string;
+    getRowId: (row: T, index: number) => string;
+}): SearchCorpusRow<T>[];
+/**
+ * Map corpus-indexed search results onto currently visible row indices for highlighting.
+ */
+declare function mapSearchResultsToVisibleKeys(results: readonly SearchResultItem[], corpus: readonly SearchCorpusRow[], visibleRowIndexById: Map<string, number>): Set<string>;
+declare function mapSearchResultToVisibleItem(item: SearchResultItem, corpus: readonly SearchCorpusRow[], visibleRowIndexById: Map<string, number>): SearchResultItem | null;
+declare function collectAncestorKeysToExpand(corpusRow: SearchCorpusRow, expandedRows: Set<string>): string[];
+
 type DataTableLabels = {
     empty: string;
     loading: string;
@@ -56,6 +118,12 @@ type DataTableLabels = {
     collapseRow: string;
     /** Accessible label for the column resize handle */
     resizeColumn: string;
+    /** Built-in find-in-page search overlay */
+    searchPlaceholder: string;
+    searchResultHint: string;
+    searchPrevious: string;
+    searchNext: string;
+    searchClose: string;
 };
 /** Default copy. Override via the `labels` option. */
 declare const DEFAULT_DATA_TABLE_LABELS: DataTableLabels;
@@ -254,6 +322,25 @@ type DataTableProps<T extends Record<string, unknown>> = {
      * Does not reorder columns; offsets stack so frozen cells do not overlap.
      */
     enableColumnFreeze?: boolean;
+    /**
+     * Enable Glide-style built-in find-in-page search (Ctrl/Cmd+F).
+     * Highlights matching cells; Enter / buttons navigate without filtering rows.
+     * Defaults to false.
+     */
+    enableInlineSearch?: boolean;
+    /** Controlled search overlay visibility. When omitted, Ctrl/Cmd+F toggles internally. */
+    showSearch?: boolean;
+    /** Controlled search query string. */
+    searchValue?: string;
+    onSearchValueChange?: (value: string) => void;
+    /**
+     * Emitted when the overlay close control is used (X / Escape / Ctrl+F in the box).
+     * Providing this shows the close button. For controlled `showSearch`, set it false here.
+     */
+    onSearchClose?: () => void;
+    /** Override the internal match list (`[colIndex, rowIndex]`). */
+    searchResults?: readonly SearchResultItem[];
+    onSearchResultsChanged?: (results: readonly SearchResultItem[], navIndex: number) => void;
     /**
      * Optional UI part replacements for the unstyled DataTable renderer.
      * Use with `createTable` / `Table.Column`, or pass columns directly to `DataTable`.
@@ -295,6 +382,12 @@ type DataTableClassNames = {
     expandToggle?: string;
     expandToggleIcon?: string;
     fillHandle?: string;
+    /** Built-in search overlay root */
+    search?: string;
+    searchInput?: string;
+    searchButton?: string;
+    searchStatus?: string;
+    searchProgress?: string;
 };
 type DataTableToolbarSlotProps = {
     filteredCount?: number;
@@ -386,8 +479,18 @@ type TableColumnProps<T extends Record<string, unknown>, K extends string = keyo
     headerClassName?: string;
     render?: (value: K extends keyof T ? T[K] : unknown, row: Row<T>, index: number) => ReactNode;
 };
+/** Declares a multi-row header group wrapping leaf `Table.Column`s. */
+type TableColumnGroupProps = {
+    /** Group header label shown in the top header row */
+    header: ReactNode;
+    children: ReactNode;
+    /** Stable group id. Auto-generated when omitted */
+    id?: string;
+    align?: "left" | "center" | "right";
+    headerClassName?: string;
+};
 type TableProps<T extends Record<string, unknown>> = Omit<DataTableProps<T>, "columns"> & {
     children: ReactNode;
 };
 
-export { type ColumnFreezeColumnInput as C, DEFAULT_DATA_TABLE_LABELS as D, type PasteMode as P, type RowSelectionMode as R, type TableColumnProps as T, type ColumnFreezeEdgeSide as a, type ColumnFreezeMeta as b, type ColumnFreezeOffset as c, type ColumnFreezeSide as d, type DataTableClassNames as e, type DataTableCopyActions as f, type DataTableLabels as g, type DataTableProps as h, type DataTableScrollSlotProps as i, type DataTableSlots as j, type RowsPastePayload as k, type TableProps as l, buildColumnFreezeOffsets as m, getColumnFreezeEdgeAttr as n, getColumnFreezeStyle as o, resolveDataTableLabels as p, type CellEditType as q, resolveColumnFreezeSide as r };
+export { getColumnFreezeEdgeAttr as A, getColumnFreezeStyle as B, type ColumnFreezeColumnInput as C, DEFAULT_DATA_TABLE_LABELS as D, mapSearchResultToVisibleItem as E, mapSearchResultsToVisibleKeys as F, nextSearchIndex as G, nextSearchStride as H, INLINE_SEARCH_MAX_RESULTS as I, previousSearchIndex as J, resolveColumnFreezeSide as K, resolveDataTableLabels as L, type CellEditType as M, type PasteMode as P, type RowSelectionMode as R, type SearchCorpusRow as S, type TableColumnGroupProps as T, type ColumnFreezeEdgeSide as a, type ColumnFreezeMeta as b, type ColumnFreezeOffset as c, type ColumnFreezeSide as d, type DataTableClassNames as e, type DataTableCopyActions as f, type DataTableLabels as g, type DataTableProps as h, type DataTableScrollSlotProps as i, type DataTableSlots as j, type RowsPastePayload as k, type SearchResultItem as l, type SearchStatus as m, type TableColumnProps as n, type TableProps as o, buildColumnFreezeOffsets as p, buildFlatSearchCorpus as q, buildSearchMatchKey as r, buildSearchMatchKeys as s, buildTreeSearchCorpus as t, cellValueToSearchText as u, collectAncestorKeysToExpand as v, collectSearchMatchesInRange as w, createSearchRegex as x, escapeSearchRegex as y, formatSearchResultLabel as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-glide-table",
-  "version": "1.4.1",
+  "version": "1.7.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zpxlffjrm/react-glide-table.git"