@ishibashi0112/spreadsheet-grid 0.13.0 → 0.15.0

package/dist/CellEditorLayer.d.ts

@@ -1,19 +1,30 @@
-export type EditorCommitDirection = 'down' | 'right' | 'left';
+import type { EditorCommitDirection, EditorCommitResult, GridColumn, GridColumnEditor } from './model/gridTypes';
+export type { EditorCommitDirection };
 type CellEditorRect = {
     left: number;
     top: number;
     width: number;
     height: number;
 };
-type CellEditorLayerProps = {
+export type CellEditorSession<T> = {
+    row: T;
+    rowIndex: number;
+    colIndex: number;
+    column: GridColumn<T>;
+    value: unknown;
+};
+type CellEditorLayerProps<T> = {
     rect: CellEditorRect | null;
     headerHeight: number;
     leadingWidth: number;
     baseOffset?: number;
     initialValue: string;
-    onCommit: (value: string, direction?: EditorCommitDirection) => void;
+    editor?: GridColumnEditor<T>;
+    editorSession?: CellEditorSession<T> | null;
+    themeClassName?: string;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
     onCancel: () => void;
     align?: 'left' | 'center' | 'right';
 };
-export declare function CellEditorLayer({ rect, headerHeight, leadingWidth, baseOffset, initialValue, onCommit, onCancel, align, }: CellEditorLayerProps): import("react").JSX.Element | null;
+export declare function CellEditorLayer<T>({ rect, headerHeight, leadingWidth, baseOffset, initialValue, editor, editorSession, themeClassName, onCommit, onCancel, align, }: CellEditorLayerProps<T>): import("react").JSX.Element | null;
 export default CellEditorLayer;

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: rowHeightProp, autoHeight, estimateRowHeight, headerHeight: headerHeightProp, density, theme, rowHeaderWidth, height, maxHeight, readOnly, dimReadOnlyCells, canEditCell, enableRangeSelection, enableRowSelection, rowSelectionMode, enableSelectAllRows: enableSelectAllRowsProp, rowSelection: rowSelectionProp, selectedRowKeys: selectedRowKeysProp, onRowSelectionChange, enableGlobalFilter, enableColumnFilter, enableSorting, enableColumnResize, autoSizeColumns, showCellOverflowTooltip, enableRowHover, enableColumnHeaderHover, enableColumnMenu, noMatchingRowsText, noRowsText, showTopBar, showBottomBar, showTopBarSummary, showTopBarFilter, globalFilterPlaceholder, globalFilterIcon, showTopBarCounts, showBottomBarCounts, showFilterChipBar, renderTopBar, renderBottomBar, className, classNames, getRowClassName, enableContextMenu, getContextMenuItems, onContextMenuOpen, 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: rowHeightProp, autoHeight, estimateRowHeight, headerHeight: headerHeightProp, density, theme, rowHeaderWidth, height, maxHeight, readOnly, dimReadOnlyCells, canEditCell, enableUndoRedo, undoHistoryLimit, onUndoRedoStateChange, enableRangeSelection, enableRowSelection, rowSelectionMode, enableSelectAllRows: enableSelectAllRowsProp, rowSelection: rowSelectionProp, selectedRowKeys: selectedRowKeysProp, onRowSelectionChange, enableGlobalFilter, enableColumnFilter, enableSorting, enableColumnResize, autoSizeColumns, showCellOverflowTooltip, enableRowHover, enableColumnHeaderHover, enableColumnMenu, noMatchingRowsText, noRowsText, showTopBar, showBottomBar, showTopBarSummary, showTopBarFilter, globalFilterPlaceholder, globalFilterIcon, showTopBarCounts, showBottomBarCounts, showFilterChipBar, renderTopBar, renderBottomBar, className, classNames, getRowClassName, enableContextMenu, getContextMenuItems, onContextMenuOpen, ref, onStateChange, }: SpreadsheetGridProps<T>): import("react").JSX.Element;

package/dist/editors/CellEditorErrorBubble.d.ts

@@ -0,0 +1,4 @@
+export declare function CellEditorErrorBubble({ message }: {
+    message: string;
+}): import("react").JSX.Element;
+export default CellEditorErrorBubble;

package/dist/editors/CheckboxCell.d.ts

@@ -0,0 +1,7 @@
+type CheckboxCellProps = {
+    checked: boolean;
+    readOnly: boolean;
+    onToggle: () => void;
+};
+export declare function CheckboxCell({ checked, readOnly, onToggle }: CheckboxCellProps): import("react").JSX.Element;
+export default CheckboxCell;

package/dist/editors/CustomCellEditor.d.ts

@@ -0,0 +1,8 @@
+import type { ReactNode } from 'react';
+import type { CellEditorContext } from '../model/gridTypes';
+type CustomCellEditorProps<T> = {
+    render: (ctx: CellEditorContext<T>) => ReactNode;
+    context: CellEditorContext<T>;
+};
+export declare function CustomCellEditor<T>({ render, context, }: CustomCellEditorProps<T>): import("react").JSX.Element;
+export default CustomCellEditor;

package/dist/editors/DateCellEditor.d.ts

@@ -0,0 +1,9 @@
+import type { EditorCommitDirection, EditorCommitResult } from '../model/gridTypes';
+type DateCellEditorProps = {
+    initialValue: string;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
+    onCancel: () => void;
+    align?: 'left' | 'center' | 'right';
+};
+export declare function DateCellEditor({ initialValue, onCommit, onCancel, align, }: DateCellEditorProps): import("react").JSX.Element;
+export default DateCellEditor;

package/dist/editors/NumberCellEditor.d.ts

@@ -0,0 +1,12 @@
+import type { EditorCommitDirection, EditorCommitResult } from '../model/gridTypes';
+type NumberCellEditorProps = {
+    initialValue: string;
+    min?: number;
+    max?: number;
+    step?: number;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
+    onCancel: () => void;
+    align?: 'left' | 'center' | 'right';
+};
+export declare function NumberCellEditor({ initialValue, min, max, step, onCommit, onCancel, align, }: NumberCellEditorProps): import("react").JSX.Element;
+export default NumberCellEditor;

package/dist/editors/SelectCellEditor.d.ts

@@ -0,0 +1,11 @@
+import type { EditorCommitDirection, EditorCommitResult, GridSelectEditorOption } from '../model/gridTypes';
+type SelectCellEditorProps = {
+    options: GridSelectEditorOption[];
+    value: unknown;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
+    onCancel: () => void;
+    align?: 'left' | 'center' | 'right';
+    themeClassName?: string;
+};
+export declare function SelectCellEditor({ options, value, onCommit, onCancel, align, themeClassName, }: SelectCellEditorProps): import("react").JSX.Element;
+export default SelectCellEditor;

package/dist/editors/TextCellEditor.d.ts

@@ -0,0 +1,9 @@
+import type { EditorCommitDirection, EditorCommitResult } from '../model/gridTypes';
+type TextCellEditorProps = {
+    initialValue: string;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
+    onCancel: () => void;
+    align?: 'left' | 'center' | 'right';
+};
+export declare function TextCellEditor({ initialValue, onCommit, onCancel, align, }: TextCellEditorProps): import("react").JSX.Element;
+export default TextCellEditor;

package/dist/editors/editorKeyBindings.d.ts

@@ -0,0 +1,10 @@
+import type { KeyboardEvent } from 'react';
+import type { EditorCommitDirection, EditorCommitResult } from '../model/gridTypes';
+type CreateEditorKeyDownHandlerArgs = {
+    value: unknown;
+    onCommit: (value: unknown, direction?: EditorCommitDirection) => EditorCommitResult | void;
+    onCancel: () => void;
+    onRejected?: (message: string) => void;
+};
+export declare const createEditorKeyDownHandler: ({ value, onCommit, onCancel, onRejected }: CreateEditorKeyDownHandlerArgs) => (event: KeyboardEvent<HTMLInputElement>) => void;
+export {};

package/dist/hooks/useGridEditController.d.ts

@@ -1,7 +1,6 @@
 import { type Dispatch, type RefObject } from 'react';
 import { type GridUiAction } from '../model/gridActions';
-import type { CellCoord, GridColumn, GridUiState, RowModel } from '../model/gridTypes';
-import type { EditorCommitDirection } from '../CellEditorLayer';
+import type { CellCoord, EditorCommitDirection, EditorCommitResult, GridColumn, GridUiState, RowModel } from '../model/gridTypes';
 type UseGridEditControllerArgs<T extends object> = {
     uiState: GridUiState;
     rows: T[];
@@ -17,7 +16,7 @@ type UseGridEditControllerArgs<T extends object> = {
 export declare const useGridEditController: <T extends object>({ uiState, rows, visibleColumns, rowModel, setEditorInitialValue, onRowsChange, dispatch, getMovedCell, gridRootRef, editorActionGuardRef, }: UseGridEditControllerArgs<T>) => {
     activateSingleCell: (cell: CellCoord) => void;
     startEditWithValue: (cell: CellCoord, initialValue: string) => void;
-    commitEdit: (committedValue: string, direction?: EditorCommitDirection) => void;
+    commitEdit: (committedValue: unknown, direction?: EditorCommitDirection) => EditorCommitResult;
     cancelEdit: () => void;
 };
 export default useGridEditController;

package/dist/hooks/useGridHistoryController.d.ts

@@ -0,0 +1,23 @@
+import type { Dispatch } from 'react';
+import { type GridUiAction } from '../model/gridActions';
+import type { CellCoord, GridSelection, UndoRedoState } from '../model/gridTypes';
+type UseGridHistoryControllerArgs<T> = {
+    rows: T[];
+    selection: GridSelection;
+    activeCell: CellCoord | null;
+    onRowsChange?: (nextRows: T[]) => void;
+    dispatch: Dispatch<GridUiAction>;
+    enabled: boolean;
+    limit: number;
+    onUndoRedoStateChange?: (state: UndoRedoState) => void;
+    onAfterRestore?: (activeCell: CellCoord | null) => void;
+};
+export declare const useGridHistoryController: <T>({ rows, selection, activeCell, onRowsChange, dispatch, enabled, limit, onUndoRedoStateChange, onAfterRestore, }: UseGridHistoryControllerArgs<T>) => {
+    handleRowsChange: ((nextRows: T[]) => void) | undefined;
+    undo: () => void;
+    redo: () => void;
+    canUndo: () => boolean;
+    canRedo: () => boolean;
+    clearHistory: () => void;
+};
+export default useGridHistoryController;

package/dist/hooks/useGridKeyboardInteractions.d.ts

@@ -13,8 +13,12 @@ type UseGridKeyboardInteractionsArgs<T> = {
     handleCellDoubleClick: (cell: CellCoord) => void;
     isWholeGridSelected: boolean;
     selectEntireGrid: () => void;
+    onUndo: () => void;
+    onRedo: () => void;
+    onClearSelection: () => void;
+    onToggleCheckboxCell: (cell: CellCoord) => void;
 };
-export declare const useGridKeyboardInteractions: <T>({ uiState, rowModel, visibleColumns, readOnly, canEditCell, setEditorInitialValue, dispatch, handleCopy, handleCellDoubleClick, isWholeGridSelected, selectEntireGrid, }: UseGridKeyboardInteractionsArgs<T>) => {
+export declare const useGridKeyboardInteractions: <T>({ uiState, rowModel, visibleColumns, readOnly, canEditCell, setEditorInitialValue, dispatch, handleCopy, handleCellDoubleClick, isWholeGridSelected, selectEntireGrid, onUndo, onRedo, onClearSelection, onToggleCheckboxCell, }: UseGridKeyboardInteractionsArgs<T>) => {
     getMovedCell: (baseCell: CellCoord, deltaRow: number, deltaCol: number) => CellCoord;
     handleKeyDown: (event: KeyboardEvent<HTMLDivElement>) => Promise<void>;
 };