@ishibashi0112/spreadsheet-grid 0.6.0 → 0.8.0

package/README.md

@@ -22,6 +22,7 @@ A high-performance, virtualized spreadsheet / data grid for **React 19**, writte
 - Both **client-side** (`rows`) and **server-side** (`dataSource`, SSRM) row models.
 - Themeable with CSS custom properties (`--ssg-*`) and a low-priority `@layer ssg-base`, so your own CSS or Tailwind utilities override the defaults without specificity battles. `className` / `classNames` slots are also provided.
 - Toggle the top / bottom bars and their parts via props — whole bars (`showTopBar` / `showBottomBar`), the default top bar's summary chips and global-filter input, and the Rows/Columns counts in each bar.
+- Built-in CSV export (`downloadCsv` / `exportCsv`), plus a library-agnostic `getExportData()` for Excel / XLSX / ODS — feed the shaped data (filter/sort/visible-order aware) to your own writer such as [hucre](https://github.com/productdevbook/hucre), ExcelJS, or SheetJS. No spreadsheet library is bundled; multi-sheet is composed on your side. See [`API_REFERENCE.md`](./src/components/spreadsheet-grid/API_REFERENCE.md).
 - TypeScript-first, fully controlled API.
 
 ## Installation
@@ -148,6 +149,7 @@ The full prop and type reference lives in [`src/components/spreadsheet-grid/API_
 - **クライアントサイド**（`rows`）と**サーバーサイド**（`dataSource`、SSRM）の両行モデル。
 - CSS カスタムプロパティ（`--ssg-*`）と優先度の低い `@layer ssg-base` によるテーマ設定。利用側の通常 CSS や Tailwind ユーティリティが特異度の競合なしに既定を上書きできます。`className` / `classNames` スロットも用意。
 - トップ / ボトムバーとその構成要素（バー全体〔`showTopBar` / `showBottomBar`〕、既定トップバーの summary chips・グローバルフィルター入力、各バーの Rows/Columns 件数）を props で表示制御。
+- CSV エクスポート（`downloadCsv` / `exportCsv`）を内蔵。Excel / XLSX / ODS はライブラリ非依存の `getExportData()` で、整形済みデータ（フィルター/ソート/可視列順を反映）を [hucre](https://github.com/productdevbook/hucre) / ExcelJS / SheetJS など任意の writer へ流す方式。xlsx ライブラリは同梱せず、マルチシートは利用側で合成。詳細は [`API_REFERENCE.md`](./src/components/spreadsheet-grid/API_REFERENCE.md)。
 - TypeScript ファースト、完全 controlled な API。
 
 ### インストール

package/dist/SpreadsheetGrid.d.ts

@@ -1,3 +1,3 @@
 import './styles.css';
 import type { SpreadsheetGridProps } from './model/gridTypes';
-export declare function SpreadsheetGrid<T extends object>({ rows, dataSource, serverSideRefreshToken, columns, onRowsChange, onColumnsChange, rowKeyGetter, createRow, createOverflowColumn, rowHeight, autoHeight, estimateRowHeight, headerHeight, rowHeaderWidth, height, maxHeight, readOnly, canEditCell, enableRangeSelection, enableGlobalFilter, enableColumnFilter, enableSorting, enableColumnResize, enableRowHover, enableColumnHeaderHover, enableColumnMenu, noMatchingRowsText, noRowsText, showTopBar, showBottomBar, showTopBarSummary, showTopBarFilter, showTopBarCounts, showBottomBarCounts, renderTopBar, renderBottomBar, className, classNames, getRowClassName, ref, onStateChange, }: SpreadsheetGridProps<T>): import("react").JSX.Element;
+export declare function SpreadsheetGrid<T extends object>({ rows, dataSource, serverSideRefreshToken, columns, onRowsChange, onColumnsChange, rowKeyGetter, createRow, createOverflowColumn, rowHeight, autoHeight, estimateRowHeight, headerHeight, rowHeaderWidth, height, maxHeight, readOnly, canEditCell, enableRangeSelection, enableRowSelection, rowSelectionMode, enableSelectAllRows: enableSelectAllRowsProp, rowSelection: rowSelectionProp, selectedRowKeys: selectedRowKeysProp, onRowSelectionChange, enableGlobalFilter, enableColumnFilter, enableSorting, enableColumnResize, enableRowHover, enableColumnHeaderHover, enableColumnMenu, noMatchingRowsText, noRowsText, showTopBar, showBottomBar, showTopBarSummary, showTopBarFilter, globalFilterPlaceholder, globalFilterIcon, showTopBarCounts, showBottomBarCounts, renderTopBar, renderBottomBar, className, classNames, getRowClassName, enableContextMenu, getContextMenuItems, onContextMenuOpen, ref, onStateChange, }: SpreadsheetGridProps<T>): import("react").JSX.Element;

package/dist/hooks/useCellContextMenuController.d.ts

@@ -0,0 +1,23 @@
+import { type RefObject } from 'react';
+import type { GridContextMenuItem, GridContextMenuParams } from '../model/gridTypes';
+export type CellContextMenuLayout = {
+    top: number;
+    left: number;
+    width: number;
+};
+type CellContextMenuState<T> = {
+    params: GridContextMenuParams<T>;
+    items: GridContextMenuItem[];
+};
+type UseCellContextMenuControllerArgs = {
+    gridRootRef: RefObject<HTMLDivElement | null>;
+};
+export declare const useCellContextMenuController: <T>({ gridRootRef, }: UseCellContextMenuControllerArgs) => {
+    contextMenuState: CellContextMenuState<T> | null;
+    contextMenuLayout: CellContextMenuLayout | null;
+    contextMenuRef: RefObject<HTMLDivElement | null>;
+    isContextMenuOpen: boolean;
+    openContextMenu: (params: GridContextMenuParams<T>, items: GridContextMenuItem[]) => void;
+    closeContextMenu: () => void;
+};
+export default useCellContextMenuController;

package/dist/hooks/useColumnHeaderDragController.d.ts

@@ -20,5 +20,6 @@ export declare const useColumnHeaderDragController: <T>(args: UseColumnHeaderDra
     leftIndicatorRef: RefObject<HTMLDivElement | null>;
     centerIndicatorRef: RefObject<HTMLDivElement | null>;
     rightIndicatorRef: RefObject<HTMLDivElement | null>;
+    applyReorderSettle: () => void;
 };
 export default useColumnHeaderDragController;

package/dist/hooks/useGlobalFilteredOrder.d.ts

@@ -0,0 +1,17 @@
+import type { GlobalFilterStatus, GridColumn } from '../model/gridTypes';
+import { type RowOrder } from '../logic/filtering';
+export declare const ASYNC_GLOBAL_FILTER_ROW_THRESHOLD = 50000;
+export type GlobalFilteredOrderResult = {
+    order: RowOrder;
+    status: GlobalFilterStatus;
+    progress: number;
+};
+type UseGlobalFilteredOrderArgs<T> = {
+    rows: T[];
+    baseOrder: RowOrder;
+    columns: GridColumn<T>[];
+    globalText: string;
+    enabled: boolean;
+};
+export declare const useGlobalFilteredOrder: <T>({ rows, baseOrder, columns, globalText, enabled, }: UseGlobalFilteredOrderArgs<T>) => GlobalFilteredOrderResult;
+export default useGlobalFilteredOrder;

package/dist/hooks/useGridBarContext.d.ts

@@ -1,5 +1,5 @@
-import type { GridColumn, GridUiState, SpreadsheetGridSlotContext } from '../model/gridTypes';
-type GridSlotContextBase<T> = Omit<SpreadsheetGridSlotContext<T>, 'setGlobalFilterText' | 'derivedSummary' | 'filteredRows'>;
+import type { GlobalFilterStatus, GridColumn, GridUiState, SpreadsheetGridSlotContext } from '../model/gridTypes';
+type GridSlotContextBase<T> = Omit<SpreadsheetGridSlotContext<T>, 'setGlobalFilterText' | 'derivedSummary' | 'filteredRows' | 'globalFilterStatus' | 'globalFilterProgress'>;
 type UseGridBarContextArgs<T> = {
     rows: T[];
     viewRowCount: number;
@@ -8,8 +8,10 @@ type UseGridBarContextArgs<T> = {
     visibleColumns: GridColumn<T>[];
     uiState: GridUiState;
     setGlobalFilterText: (value: string) => void;
+    globalFilterStatus: GlobalFilterStatus;
+    globalFilterProgress: number;
 };
-export declare const useGridBarContext: <T>({ rows, viewRowCount, getFilteredRows, columns, visibleColumns, uiState, setGlobalFilterText, }: UseGridBarContextArgs<T>) => {
+export declare const useGridBarContext: <T>({ rows, viewRowCount, getFilteredRows, columns, visibleColumns, uiState, setGlobalFilterText, globalFilterStatus, globalFilterProgress, }: UseGridBarContextArgs<T>) => {
     slotContextBase: GridSlotContextBase<T>;
     derivedSummary: import("..").SpreadsheetGridDerivedSummary;
     slotContext: SpreadsheetGridSlotContext<T>;

package/dist/hooks/useGridPointerInteractions.d.ts

@@ -32,8 +32,13 @@ type UseGridPointerInteractionsArgs<T> = {
     setHoveredColumnIndex: (value: number | null) => void;
     enableRowHover: boolean;
     enableColumnHeaderHover: boolean;
+    enableRowSelection: boolean;
+    onGutterRowSelect: (viewIndex: number, opts: {
+        shiftKey: boolean;
+    }) => void;
+    onGutterRowSelectDrag: (viewIndex: number) => void;
 };
-export declare const useGridPointerInteractions: <T>({ gridRootRef, bodyScrollRef, scrollContainerRef, leftPaneScrollRef, rightPaneScrollRef, pointerClientRef, autoScrollFrameRef, uiState, dispatch, enableRangeSelection, enableSorting, orderedColumns, filteredRowsLength, visibleColumnsLength, paneLayout, leftLeadingWidth, centerLeadingWidth, rightLeadingWidth, headerHeight, rowMetrics, verticalScaleFactor, setHoveredRowIndex, setHoveredColumnIndex, enableRowHover, enableColumnHeaderHover, }: UseGridPointerInteractionsArgs<T>) => {
+export declare const useGridPointerInteractions: <T>({ gridRootRef, bodyScrollRef, scrollContainerRef, leftPaneScrollRef, rightPaneScrollRef, pointerClientRef, autoScrollFrameRef, uiState, dispatch, enableRangeSelection, enableSorting, orderedColumns, filteredRowsLength, visibleColumnsLength, paneLayout, leftLeadingWidth, centerLeadingWidth, rightLeadingWidth, headerHeight, rowMetrics, verticalScaleFactor, setHoveredRowIndex, setHoveredColumnIndex, enableRowHover, enableColumnHeaderHover, enableRowSelection, onGutterRowSelect, onGutterRowSelectDrag, }: UseGridPointerInteractionsArgs<T>) => {
     updateSelectionFromPointer: (clientX: number, clientY: number) => void;
     handleCellPointerDown: (cell: CellCoord, event: PointerEvent<HTMLDivElement>) => void;
     handleCellPointerEnter: (cell: CellCoord, event: PointerEvent<HTMLDivElement>) => void;