@pixerate/editor-react 0.16.0 → 0.18.0

package/dist/spreadsheet/index.d.cts

@@ -1,11 +1,38 @@
 import * as _pixerate_editor from '@pixerate/editor';
-import { SpreadsheetControllerOptions, CellRange, SpreadsheetDocument, CellCoordinate, SpreadsheetController, SpreadsheetColumn, SpreadsheetRow, SpreadsheetDataSource, CellData, SpreadsheetMenuItem, SpreadsheetRowGroup, SpreadsheetViewColumn } from '@pixerate/editor/spreadsheet';
+import { SpreadsheetControllerOptions, SpreadsheetDocument, SpreadsheetNameScope, CellRange, CellCoordinate, SpreadsheetValidationPrompt, SpreadsheetValidationAction, SpreadsheetCommitResult, SpreadsheetController, SpreadsheetColumn, SpreadsheetRow, SpreadsheetDataSource, CellData, SpreadsheetMenuItem, SpreadsheetPanelId, SpreadsheetRowGroup, SpreadsheetViewColumn, FormulaNameSuggestionSource, SpreadsheetViewMetrics, SpreadsheetViewWindow, SpreadsheetViewModel } from '@pixerate/editor/spreadsheet';
 import React__default, { RefObject } from 'react';
 
 declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
-    viewModel: _pixerate_editor.SpreadsheetViewModel;
+    conditionalFormatOverlay: _pixerate_editor.ConditionalFormatOverlay;
     undo: () => void;
     redo: () => void;
+    setActiveSheet: (idOrName: string) => boolean;
+    addSheet: (options?: {
+        name?: string;
+        index?: number;
+        document?: Partial<SpreadsheetDocument>;
+        activate?: boolean;
+    }) => string;
+    renameSheet: (idOrName: string, newName: string) => void;
+    moveSheet: (idOrName: string, toIndex: number) => boolean;
+    deleteSheet: (idOrName: string) => boolean;
+    duplicateSheet: (idOrName: string, options?: {
+        name?: string;
+        index?: number;
+        activate?: boolean;
+    }) => string | null;
+    defineName: (name: string, refersTo: string, options?: SpreadsheetNameScope & {
+        comment?: string;
+    }) => void;
+    renameName: (oldName: string, newName: string, options?: SpreadsheetNameScope) => void;
+    deleteName: (name: string, options?: SpreadsheetNameScope) => boolean;
+    viewModel: _pixerate_editor.SpreadsheetViewModel;
+    /** The sheets in tab order (see `SpreadsheetController.getSheets`). */
+    sheets: _pixerate_editor.SpreadsheetSheetInfo[];
+    activeSheetId: string;
+    /** Defined names (see `SpreadsheetController.getNames`). */
+    names: _pixerate_editor.SpreadsheetNameInfo[];
+    mergeCells: (range?: CellRange | null) => boolean;
     sortRows: (keys: _pixerate_editor.SortKey[], options?: {
         range?: CellRange | null;
     }) => boolean;
@@ -29,7 +56,6 @@ declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
     unhideAll: () => void;
     getMerges: () => CellRange[];
     getMergeAt: (row: number, col: number) => CellRange | null;
-    mergeCells: (range?: CellRange | null) => boolean;
     unmergeCells: (range?: CellRange | null) => boolean;
     autofill: (source: CellRange, target: CellRange) => boolean;
     groupRowsBy: (colId: string, summaries?: _pixerate_editor.GroupSummary[]) => void;
@@ -45,19 +71,46 @@ declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
     importFromCsv: (csv: string, options?: _pixerate_editor.CsvImportOptions) => void;
     copyToClipboardData: (range?: CellRange | null) => _pixerate_editor.SpreadsheetClipboardData;
     pasteClipboardData: (source: _pixerate_editor.SpreadsheetClipboardSource, target?: _pixerate_editor.CellPosition) => boolean;
+    getConditionalFormats: () => _pixerate_editor.ConditionalFormatRule[];
+    addConditionalFormat: (rule: _pixerate_editor.NewConditionalFormatRule, options?: {
+        priority?: "first" | "last";
+    }) => string;
+    updateConditionalFormat: (id: string, changes: Partial<_pixerate_editor.NewConditionalFormatRule>) => boolean;
+    deleteConditionalFormat: (id: string) => boolean;
+    moveConditionalFormat: (id: string, to: number | {
+        by: number;
+    }) => boolean;
+    clearConditionalFormats: (range?: CellRange | null) => void;
+    getConditionalFormatOverlay: () => _pixerate_editor.ConditionalFormatOverlay;
+    getConditionalFormat: (row: number, col: number) => _pixerate_editor.ConditionalCellFormat | undefined;
+    getDataValidations: () => _pixerate_editor.DataValidationRule[];
+    getDataValidationAt: (row: number, col: number) => _pixerate_editor.DataValidationRule | undefined;
+    addDataValidation: (rule: _pixerate_editor.NewDataValidationRule) => string;
+    updateDataValidation: (id: string, changes: Partial<_pixerate_editor.NewDataValidationRule>) => boolean;
+    deleteDataValidation: (id: string) => boolean;
+    clearDataValidation: (range?: CellRange | null) => void;
+    validateCellInput: (row: number, col: number, raw: string) => _pixerate_editor.DataValidationResult;
+    getValidationListValues: (row: number, col: number) => string[] | null;
+    findInvalidCells: () => _pixerate_editor.CellPosition[];
+    setInvalidDataCircles: (show: boolean) => void;
+    getInvalidDataCircles: () => boolean;
+    isInvalidDataCircled: (row: number, col: number) => boolean;
     document: SpreadsheetDocument;
     activeCell: CellCoordinate | null;
     selectedRange: CellRange | null;
     editingCell: CellCoordinate | null;
     draftValue: string;
     setDraftValue: (value: string) => void;
+    validationPrompt: SpreadsheetValidationPrompt | null;
+    resolveValidationPrompt: (action: SpreadsheetValidationAction) => void;
+    commitCellInput: (rowId: string, colId: string, raw: string) => SpreadsheetCommitResult;
     controller: SpreadsheetController;
     getCell: (rowId: string, colId: string) => _pixerate_editor.CellData;
     setCellValue: (rowId: string, colId: string, raw: string) => void;
     selectCell: (row: number, col: number, extendSelection?: boolean) => void;
     selectRange: (range: CellRange) => void;
     startEditing: (row?: number, col?: number, initialVal?: string) => void;
-    commitEditing: (val?: string) => void;
+    commitEditing: (val?: string) => SpreadsheetCommitResult;
     cancelEditing: () => void;
     moveCursor: (dir: "up" | "down" | "left" | "right", extend?: boolean) => void;
     insertColumn: (index: number, config?: Partial<SpreadsheetColumn>) => void;
@@ -86,6 +139,14 @@ interface SpreadsheetEditorProps {
     onAddColumnClick?: () => void;
     onColumnHeaderClick?: (col: SpreadsheetColumn) => void;
     onColumnResize?: (colId: string, width: number) => void;
+    /** Show the sheet tabs bar under the grid (add, switch, rename, reorder, delete sheets). */
+    showSheetTabs?: boolean;
+    /**
+     * Render only the rows and columns in (or near) view. `'auto'` (default)
+     * virtualises sheets with more than 200 displayed rows or 60 columns;
+     * `true` / `false` force it.
+     */
+    virtualize?: boolean | 'auto';
 }
 declare const SpreadsheetEditor: React__default.FC<SpreadsheetEditorProps>;
 
@@ -94,6 +155,10 @@ interface SpreadsheetContextMenuProps {
     x: number;
     y: number;
     onClose: () => void;
+    /** Accessible name of the menu (default "Table actions"). */
+    ariaLabel?: string;
+    /** Opens a panel for items with `panel` (conditional formatting, data validation). */
+    onOpenPanel?: (panel: SpreadsheetPanelId) => void;
 }
 /** The table context menu (sort, filter, freeze, hide, merge, categories, transpose). */
 declare const SpreadsheetContextMenu: React__default.FC<SpreadsheetContextMenuProps>;
@@ -106,11 +171,17 @@ interface SpreadsheetGroupRowProps {
     onToggle: (key: string) => void;
     /** Render a trailing cell for the "add column" column. */
     trailingCell?: boolean;
+    /** Every displayed column, when `columns` is a virtualised window of them (picks the label column). */
+    labelColumns?: SpreadsheetViewColumn[];
+    /** Virtualised: columns before the left spacer (the frozen ones), and the spacers' widths. */
+    leadingColumns?: number;
+    leftSpace?: number;
+    rightSpace?: number;
 }
 /** A category header row: collapse toggle, label, row count and per-column summaries. */
 declare const SpreadsheetGroupRow: React__default.FC<SpreadsheetGroupRowProps>;
 
-type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
+type SpreadsheetState$1 = ReturnType<typeof useSpreadsheetEditor>;
 /**
  * Copy and paste for the grid. Copy writes TSV, an HTML table and the
  * lossless `application/x.pixerate.spreadsheet+json` format; paste prefers
@@ -120,14 +191,14 @@ type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
  * `copy`/`paste` at `<body>`, not at the focused grid. Text inputs inside the
  * grid keep native copy/paste.
  */
-declare function useSpreadsheetClipboard(gridRef: RefObject<HTMLElement | null>, state: SpreadsheetState, readOnly: boolean): {
+declare function useSpreadsheetClipboard(gridRef: RefObject<HTMLElement | null>, state: SpreadsheetState$1, readOnly: boolean): {
     copyShortcutFallback: () => void;
 };
 /**
  * Fill handle dragging: press on the handle, move over cells, release to
  * autofill from the selection into the dragged range (one undo step).
  */
-declare function useFillHandle(state: SpreadsheetState): {
+declare function useFillHandle(state: SpreadsheetState$1): {
     fillTarget: CellRange | null;
     isFilling: boolean;
     startFill: (e: {
@@ -146,6 +217,8 @@ interface FormulaHintsProps {
     onAccept: (value: string) => void;
     /** Maximum number of function suggestions (default 8). */
     limit?: number;
+    /** Defined names to suggest too (e.g. `controller.getNameSuggestions()`). */
+    names?: readonly FormulaNameSuggestionSource[];
 }
 /**
  * Formula autocomplete for an input: while the value starts with `=`, lists
@@ -158,4 +231,79 @@ interface FormulaHintsProps {
  */
 declare const FormulaHints: React__default.FC<FormulaHintsProps>;
 
-export { FormulaHints, type FormulaHintsProps, SpreadsheetContextMenu, type SpreadsheetContextMenuProps, SpreadsheetEditor, type SpreadsheetEditorProps, SpreadsheetGroupRow, type SpreadsheetGroupRowProps, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor };
+interface SheetTabsProps {
+    state: ReturnType<typeof useSpreadsheetEditor>;
+    readOnly?: boolean;
+    className?: string;
+}
+/**
+ * The workbook's sheet tabs: click to switch, double-click to rename, drag
+ * to reorder, right-click for insert / rename / duplicate / move / delete
+ * (delete asks to confirm), and a `+` button to add a sheet.
+ */
+declare const SheetTabs: React__default.FC<SheetTabsProps>;
+
+interface NameManagerProps {
+    state: ReturnType<typeof useSpreadsheetEditor>;
+    readOnly?: boolean;
+    onClose?: () => void;
+    className?: string;
+}
+/**
+ * A simple Name Manager: lists defined names (name, current value, formula,
+ * scope) and adds, edits, renames and deletes them. Renaming a name rewrites
+ * the formulas that use it; deleting one leaves them showing `#NAME?`.
+ */
+declare const NameManager: React__default.FC<NameManagerProps>;
+
+interface SpreadsheetValidationDialogProps {
+    prompt: SpreadsheetValidationPrompt;
+    onResolve: (action: SpreadsheetValidationAction) => void;
+}
+/**
+ * The data validation alert: Stop (Retry / Cancel), Warning ("Continue?"
+ * Yes / No / Cancel) or Information (OK / Cancel), as in Excel.
+ */
+declare const SpreadsheetValidationDialog: React__default.FC<SpreadsheetValidationDialogProps>;
+
+type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
+interface SpreadsheetRulePanelProps {
+    state: SpreadsheetState;
+    onClose: () => void;
+}
+/**
+ * Conditional formatting manager: the sheet's rules in priority order (move,
+ * stop if true, delete) and a form to add a rule to a range.
+ */
+declare const SpreadsheetConditionalFormatPanel: React__default.FC<SpreadsheetRulePanelProps>;
+/**
+ * Data validation manager: the sheet's rules (delete), a form to validate a
+ * range, and "circle invalid data".
+ */
+declare const SpreadsheetDataValidationPanel: React__default.FC<SpreadsheetRulePanelProps>;
+
+interface SpreadsheetViewportOptions {
+    /** `'auto'` (default): virtualise large views only; `true` / `false` force it. */
+    virtualize?: boolean | 'auto';
+    /** Merged ranges, rendered whole when they cross the window's edge. */
+    merges?: readonly CellRange[];
+    /** Scrolled into view when it changes (virtualised views only). */
+    activeCell?: CellCoordinate | null;
+    overscanRows?: number;
+    overscanColumns?: number;
+}
+interface SpreadsheetViewportState {
+    metrics: SpreadsheetViewMetrics;
+    /** What to render; `virtual: false` renders every row and column. */
+    window: SpreadsheetViewWindow;
+    /** Attach to the scroll container's `onScroll`. */
+    onScroll: () => void;
+}
+/**
+ * Virtualised rendering for `SpreadsheetEditor`: tracks the scroll
+ * container (`scrollRef`), works out the window of rows and columns to
+ * render, and scrolls the active cell into view.
+ */
+declare function useSpreadsheetViewport(scrollRef: RefObject<HTMLElement | null>, view: SpreadsheetViewModel, options?: SpreadsheetViewportOptions): SpreadsheetViewportState;
+
+export { FormulaHints, type FormulaHintsProps, NameManager, type NameManagerProps, SheetTabs, type SheetTabsProps, SpreadsheetConditionalFormatPanel, SpreadsheetContextMenu, type SpreadsheetContextMenuProps, SpreadsheetDataValidationPanel, SpreadsheetEditor, type SpreadsheetEditorProps, SpreadsheetGroupRow, type SpreadsheetGroupRowProps, type SpreadsheetRulePanelProps, SpreadsheetValidationDialog, type SpreadsheetValidationDialogProps, type SpreadsheetViewportOptions, type SpreadsheetViewportState, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor, useSpreadsheetViewport };

package/dist/spreadsheet/index.d.ts

@@ -1,11 +1,38 @@
 import * as _pixerate_editor from '@pixerate/editor';
-import { SpreadsheetControllerOptions, CellRange, SpreadsheetDocument, CellCoordinate, SpreadsheetController, SpreadsheetColumn, SpreadsheetRow, SpreadsheetDataSource, CellData, SpreadsheetMenuItem, SpreadsheetRowGroup, SpreadsheetViewColumn } from '@pixerate/editor/spreadsheet';
+import { SpreadsheetControllerOptions, SpreadsheetDocument, SpreadsheetNameScope, CellRange, CellCoordinate, SpreadsheetValidationPrompt, SpreadsheetValidationAction, SpreadsheetCommitResult, SpreadsheetController, SpreadsheetColumn, SpreadsheetRow, SpreadsheetDataSource, CellData, SpreadsheetMenuItem, SpreadsheetPanelId, SpreadsheetRowGroup, SpreadsheetViewColumn, FormulaNameSuggestionSource, SpreadsheetViewMetrics, SpreadsheetViewWindow, SpreadsheetViewModel } from '@pixerate/editor/spreadsheet';
 import React__default, { RefObject } from 'react';
 
 declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
-    viewModel: _pixerate_editor.SpreadsheetViewModel;
+    conditionalFormatOverlay: _pixerate_editor.ConditionalFormatOverlay;
     undo: () => void;
     redo: () => void;
+    setActiveSheet: (idOrName: string) => boolean;
+    addSheet: (options?: {
+        name?: string;
+        index?: number;
+        document?: Partial<SpreadsheetDocument>;
+        activate?: boolean;
+    }) => string;
+    renameSheet: (idOrName: string, newName: string) => void;
+    moveSheet: (idOrName: string, toIndex: number) => boolean;
+    deleteSheet: (idOrName: string) => boolean;
+    duplicateSheet: (idOrName: string, options?: {
+        name?: string;
+        index?: number;
+        activate?: boolean;
+    }) => string | null;
+    defineName: (name: string, refersTo: string, options?: SpreadsheetNameScope & {
+        comment?: string;
+    }) => void;
+    renameName: (oldName: string, newName: string, options?: SpreadsheetNameScope) => void;
+    deleteName: (name: string, options?: SpreadsheetNameScope) => boolean;
+    viewModel: _pixerate_editor.SpreadsheetViewModel;
+    /** The sheets in tab order (see `SpreadsheetController.getSheets`). */
+    sheets: _pixerate_editor.SpreadsheetSheetInfo[];
+    activeSheetId: string;
+    /** Defined names (see `SpreadsheetController.getNames`). */
+    names: _pixerate_editor.SpreadsheetNameInfo[];
+    mergeCells: (range?: CellRange | null) => boolean;
     sortRows: (keys: _pixerate_editor.SortKey[], options?: {
         range?: CellRange | null;
     }) => boolean;
@@ -29,7 +56,6 @@ declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
     unhideAll: () => void;
     getMerges: () => CellRange[];
     getMergeAt: (row: number, col: number) => CellRange | null;
-    mergeCells: (range?: CellRange | null) => boolean;
     unmergeCells: (range?: CellRange | null) => boolean;
     autofill: (source: CellRange, target: CellRange) => boolean;
     groupRowsBy: (colId: string, summaries?: _pixerate_editor.GroupSummary[]) => void;
@@ -45,19 +71,46 @@ declare function useSpreadsheetEditor(options?: SpreadsheetControllerOptions): {
     importFromCsv: (csv: string, options?: _pixerate_editor.CsvImportOptions) => void;
     copyToClipboardData: (range?: CellRange | null) => _pixerate_editor.SpreadsheetClipboardData;
     pasteClipboardData: (source: _pixerate_editor.SpreadsheetClipboardSource, target?: _pixerate_editor.CellPosition) => boolean;
+    getConditionalFormats: () => _pixerate_editor.ConditionalFormatRule[];
+    addConditionalFormat: (rule: _pixerate_editor.NewConditionalFormatRule, options?: {
+        priority?: "first" | "last";
+    }) => string;
+    updateConditionalFormat: (id: string, changes: Partial<_pixerate_editor.NewConditionalFormatRule>) => boolean;
+    deleteConditionalFormat: (id: string) => boolean;
+    moveConditionalFormat: (id: string, to: number | {
+        by: number;
+    }) => boolean;
+    clearConditionalFormats: (range?: CellRange | null) => void;
+    getConditionalFormatOverlay: () => _pixerate_editor.ConditionalFormatOverlay;
+    getConditionalFormat: (row: number, col: number) => _pixerate_editor.ConditionalCellFormat | undefined;
+    getDataValidations: () => _pixerate_editor.DataValidationRule[];
+    getDataValidationAt: (row: number, col: number) => _pixerate_editor.DataValidationRule | undefined;
+    addDataValidation: (rule: _pixerate_editor.NewDataValidationRule) => string;
+    updateDataValidation: (id: string, changes: Partial<_pixerate_editor.NewDataValidationRule>) => boolean;
+    deleteDataValidation: (id: string) => boolean;
+    clearDataValidation: (range?: CellRange | null) => void;
+    validateCellInput: (row: number, col: number, raw: string) => _pixerate_editor.DataValidationResult;
+    getValidationListValues: (row: number, col: number) => string[] | null;
+    findInvalidCells: () => _pixerate_editor.CellPosition[];
+    setInvalidDataCircles: (show: boolean) => void;
+    getInvalidDataCircles: () => boolean;
+    isInvalidDataCircled: (row: number, col: number) => boolean;
     document: SpreadsheetDocument;
     activeCell: CellCoordinate | null;
     selectedRange: CellRange | null;
     editingCell: CellCoordinate | null;
     draftValue: string;
     setDraftValue: (value: string) => void;
+    validationPrompt: SpreadsheetValidationPrompt | null;
+    resolveValidationPrompt: (action: SpreadsheetValidationAction) => void;
+    commitCellInput: (rowId: string, colId: string, raw: string) => SpreadsheetCommitResult;
     controller: SpreadsheetController;
     getCell: (rowId: string, colId: string) => _pixerate_editor.CellData;
     setCellValue: (rowId: string, colId: string, raw: string) => void;
     selectCell: (row: number, col: number, extendSelection?: boolean) => void;
     selectRange: (range: CellRange) => void;
     startEditing: (row?: number, col?: number, initialVal?: string) => void;
-    commitEditing: (val?: string) => void;
+    commitEditing: (val?: string) => SpreadsheetCommitResult;
     cancelEditing: () => void;
     moveCursor: (dir: "up" | "down" | "left" | "right", extend?: boolean) => void;
     insertColumn: (index: number, config?: Partial<SpreadsheetColumn>) => void;
@@ -86,6 +139,14 @@ interface SpreadsheetEditorProps {
     onAddColumnClick?: () => void;
     onColumnHeaderClick?: (col: SpreadsheetColumn) => void;
     onColumnResize?: (colId: string, width: number) => void;
+    /** Show the sheet tabs bar under the grid (add, switch, rename, reorder, delete sheets). */
+    showSheetTabs?: boolean;
+    /**
+     * Render only the rows and columns in (or near) view. `'auto'` (default)
+     * virtualises sheets with more than 200 displayed rows or 60 columns;
+     * `true` / `false` force it.
+     */
+    virtualize?: boolean | 'auto';
 }
 declare const SpreadsheetEditor: React__default.FC<SpreadsheetEditorProps>;
 
@@ -94,6 +155,10 @@ interface SpreadsheetContextMenuProps {
     x: number;
     y: number;
     onClose: () => void;
+    /** Accessible name of the menu (default "Table actions"). */
+    ariaLabel?: string;
+    /** Opens a panel for items with `panel` (conditional formatting, data validation). */
+    onOpenPanel?: (panel: SpreadsheetPanelId) => void;
 }
 /** The table context menu (sort, filter, freeze, hide, merge, categories, transpose). */
 declare const SpreadsheetContextMenu: React__default.FC<SpreadsheetContextMenuProps>;
@@ -106,11 +171,17 @@ interface SpreadsheetGroupRowProps {
     onToggle: (key: string) => void;
     /** Render a trailing cell for the "add column" column. */
     trailingCell?: boolean;
+    /** Every displayed column, when `columns` is a virtualised window of them (picks the label column). */
+    labelColumns?: SpreadsheetViewColumn[];
+    /** Virtualised: columns before the left spacer (the frozen ones), and the spacers' widths. */
+    leadingColumns?: number;
+    leftSpace?: number;
+    rightSpace?: number;
 }
 /** A category header row: collapse toggle, label, row count and per-column summaries. */
 declare const SpreadsheetGroupRow: React__default.FC<SpreadsheetGroupRowProps>;
 
-type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
+type SpreadsheetState$1 = ReturnType<typeof useSpreadsheetEditor>;
 /**
  * Copy and paste for the grid. Copy writes TSV, an HTML table and the
  * lossless `application/x.pixerate.spreadsheet+json` format; paste prefers
@@ -120,14 +191,14 @@ type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
  * `copy`/`paste` at `<body>`, not at the focused grid. Text inputs inside the
  * grid keep native copy/paste.
  */
-declare function useSpreadsheetClipboard(gridRef: RefObject<HTMLElement | null>, state: SpreadsheetState, readOnly: boolean): {
+declare function useSpreadsheetClipboard(gridRef: RefObject<HTMLElement | null>, state: SpreadsheetState$1, readOnly: boolean): {
     copyShortcutFallback: () => void;
 };
 /**
  * Fill handle dragging: press on the handle, move over cells, release to
  * autofill from the selection into the dragged range (one undo step).
  */
-declare function useFillHandle(state: SpreadsheetState): {
+declare function useFillHandle(state: SpreadsheetState$1): {
     fillTarget: CellRange | null;
     isFilling: boolean;
     startFill: (e: {
@@ -146,6 +217,8 @@ interface FormulaHintsProps {
     onAccept: (value: string) => void;
     /** Maximum number of function suggestions (default 8). */
     limit?: number;
+    /** Defined names to suggest too (e.g. `controller.getNameSuggestions()`). */
+    names?: readonly FormulaNameSuggestionSource[];
 }
 /**
  * Formula autocomplete for an input: while the value starts with `=`, lists
@@ -158,4 +231,79 @@ interface FormulaHintsProps {
  */
 declare const FormulaHints: React__default.FC<FormulaHintsProps>;
 
-export { FormulaHints, type FormulaHintsProps, SpreadsheetContextMenu, type SpreadsheetContextMenuProps, SpreadsheetEditor, type SpreadsheetEditorProps, SpreadsheetGroupRow, type SpreadsheetGroupRowProps, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor };
+interface SheetTabsProps {
+    state: ReturnType<typeof useSpreadsheetEditor>;
+    readOnly?: boolean;
+    className?: string;
+}
+/**
+ * The workbook's sheet tabs: click to switch, double-click to rename, drag
+ * to reorder, right-click for insert / rename / duplicate / move / delete
+ * (delete asks to confirm), and a `+` button to add a sheet.
+ */
+declare const SheetTabs: React__default.FC<SheetTabsProps>;
+
+interface NameManagerProps {
+    state: ReturnType<typeof useSpreadsheetEditor>;
+    readOnly?: boolean;
+    onClose?: () => void;
+    className?: string;
+}
+/**
+ * A simple Name Manager: lists defined names (name, current value, formula,
+ * scope) and adds, edits, renames and deletes them. Renaming a name rewrites
+ * the formulas that use it; deleting one leaves them showing `#NAME?`.
+ */
+declare const NameManager: React__default.FC<NameManagerProps>;
+
+interface SpreadsheetValidationDialogProps {
+    prompt: SpreadsheetValidationPrompt;
+    onResolve: (action: SpreadsheetValidationAction) => void;
+}
+/**
+ * The data validation alert: Stop (Retry / Cancel), Warning ("Continue?"
+ * Yes / No / Cancel) or Information (OK / Cancel), as in Excel.
+ */
+declare const SpreadsheetValidationDialog: React__default.FC<SpreadsheetValidationDialogProps>;
+
+type SpreadsheetState = ReturnType<typeof useSpreadsheetEditor>;
+interface SpreadsheetRulePanelProps {
+    state: SpreadsheetState;
+    onClose: () => void;
+}
+/**
+ * Conditional formatting manager: the sheet's rules in priority order (move,
+ * stop if true, delete) and a form to add a rule to a range.
+ */
+declare const SpreadsheetConditionalFormatPanel: React__default.FC<SpreadsheetRulePanelProps>;
+/**
+ * Data validation manager: the sheet's rules (delete), a form to validate a
+ * range, and "circle invalid data".
+ */
+declare const SpreadsheetDataValidationPanel: React__default.FC<SpreadsheetRulePanelProps>;
+
+interface SpreadsheetViewportOptions {
+    /** `'auto'` (default): virtualise large views only; `true` / `false` force it. */
+    virtualize?: boolean | 'auto';
+    /** Merged ranges, rendered whole when they cross the window's edge. */
+    merges?: readonly CellRange[];
+    /** Scrolled into view when it changes (virtualised views only). */
+    activeCell?: CellCoordinate | null;
+    overscanRows?: number;
+    overscanColumns?: number;
+}
+interface SpreadsheetViewportState {
+    metrics: SpreadsheetViewMetrics;
+    /** What to render; `virtual: false` renders every row and column. */
+    window: SpreadsheetViewWindow;
+    /** Attach to the scroll container's `onScroll`. */
+    onScroll: () => void;
+}
+/**
+ * Virtualised rendering for `SpreadsheetEditor`: tracks the scroll
+ * container (`scrollRef`), works out the window of rows and columns to
+ * render, and scrolls the active cell into view.
+ */
+declare function useSpreadsheetViewport(scrollRef: RefObject<HTMLElement | null>, view: SpreadsheetViewModel, options?: SpreadsheetViewportOptions): SpreadsheetViewportState;
+
+export { FormulaHints, type FormulaHintsProps, NameManager, type NameManagerProps, SheetTabs, type SheetTabsProps, SpreadsheetConditionalFormatPanel, SpreadsheetContextMenu, type SpreadsheetContextMenuProps, SpreadsheetDataValidationPanel, SpreadsheetEditor, type SpreadsheetEditorProps, SpreadsheetGroupRow, type SpreadsheetGroupRowProps, type SpreadsheetRulePanelProps, SpreadsheetValidationDialog, type SpreadsheetValidationDialogProps, type SpreadsheetViewportOptions, type SpreadsheetViewportState, useFillHandle, useSpreadsheetClipboard, useSpreadsheetEditor, useSpreadsheetViewport };

package/dist/spreadsheet/index.js

@@ -1,19 +1,31 @@
 import {
   FormulaHints,
+  NameManager,
+  SheetTabs,
+  SpreadsheetConditionalFormatPanel,
   SpreadsheetContextMenu,
+  SpreadsheetDataValidationPanel,
   SpreadsheetEditor,
   SpreadsheetGroupRow,
+  SpreadsheetValidationDialog,
   useFillHandle,
   useSpreadsheetClipboard,
-  useSpreadsheetEditor
-} from "../chunk-FYIPXHAE.js";
+  useSpreadsheetEditor,
+  useSpreadsheetViewport
+} from "../chunk-34HEZX7J.js";
 export {
   FormulaHints,
+  NameManager,
+  SheetTabs,
+  SpreadsheetConditionalFormatPanel,
   SpreadsheetContextMenu,
+  SpreadsheetDataValidationPanel,
   SpreadsheetEditor,
   SpreadsheetGroupRow,
+  SpreadsheetValidationDialog,
   useFillHandle,
   useSpreadsheetClipboard,
-  useSpreadsheetEditor
+  useSpreadsheetEditor,
+  useSpreadsheetViewport
 };
 //# sourceMappingURL=index.js.map