@extend-ai/react-xlsx 0.17.3 → 0.18.1

package/dist/index.d.cts

@@ -149,6 +149,7 @@ interface XlsxCellRange {
     end: XlsxCellAddress;
     start: XlsxCellAddress;
 }
+type XlsxMergeMode = "cells" | "center" | "across";
 interface XlsxParsedRange {
     kind: "cells" | "rows" | "columns";
     range: XlsxCellRange;
@@ -718,6 +719,7 @@ interface XlsxChartAxis {
     max?: number;
     min?: number;
     majorGridlines?: boolean;
+    majorGridlineColor?: string;
     majorTickMark?: string;
     minorUnit?: number;
     minorGridlines?: boolean;
@@ -864,6 +866,7 @@ interface XlsxChart {
     varyColors?: boolean;
     view3d?: {
         depthPercent?: number;
+        heightPercent?: number;
         perspective?: number;
         rAngAx?: boolean;
         rotX?: number;
@@ -934,6 +937,8 @@ interface XlsxChartLoadingRenderProps {
     defaultNode: React.ReactNode;
     /** The chart rectangle in viewer pixels, including the current zoom level. */
     rect: XlsxImageRect;
+    /** Identifies whether chart metadata, rendering code, or map geometry is loading. */
+    stage?: "metadata" | "renderer" | "map";
 }
 interface XlsxFileTooLargeRenderProps {
     /** The built-in file-too-large message. */
@@ -1104,7 +1109,8 @@ interface XlsxViewerController {
     images: XlsxImage[];
     moveChartBy: (id: string, deltaX: number, deltaY: number) => void;
     shapes: XlsxShape[];
-    mergeSelection: () => void;
+    /** Merges the selection; defaults to preserving its existing alignment. */
+    mergeSelection: (mode?: XlsxMergeMode) => void;
     maxZoomScale: number;
     minZoomScale: number;
     moveImageBy: (id: string, deltaX: number, deltaY: number) => void;
@@ -1245,6 +1251,39 @@ interface XlsxViewerZoom {
     zoomOut: () => void;
     zoomScale: number;
 }
+type XlsxContextMenuActionId = "cut" | "copy" | "paste" | "clearContents" | "editCell" | "undo" | "redo" | "mergeCells" | "mergeAndCenter" | "mergeAcross" | "unmergeCells" | "sortAscending" | "sortDescending" | "selectRow" | "selectColumn" | "selectAll";
+interface XlsxContextMenuAction {
+    id: XlsxContextMenuActionId;
+    label: string;
+    shortcut?: string;
+    disabled?: boolean;
+    destructive?: boolean;
+    separatorBefore?: boolean;
+}
+interface XlsxContextMenuContext {
+    kind: "cell" | "row" | "column" | "sheet";
+    cell: XlsxCellAddress;
+    selection: XlsxCellRange;
+    sheetIndex: number;
+    sheetName: string;
+    readOnly: boolean;
+}
+interface XlsxContextMenuRenderProps {
+    context: XlsxContextMenuContext;
+    actions: XlsxContextMenuAction[];
+    /** Returns whether the command completed; failures remain visible in the menu. */
+    runAction: (actionId: XlsxContextMenuActionId) => Promise<boolean>;
+    closeMenu: () => void;
+    /** Viewport coordinates. The menu container handles positioning and edge clamping. */
+    position: {
+        x: number;
+        y: number;
+    };
+    isDark: boolean;
+    busy: boolean;
+    error: string | null;
+    defaultNode: React.ReactNode;
+}
 interface XlsxViewerEditing {
     addSheet: (name?: string) => void;
     addFormControl: (input: XlsxFormControlInput, sheetIndex?: number) => number | null;
@@ -1260,7 +1299,7 @@ interface XlsxViewerEditing {
     getCellFormula: (cell?: XlsxCellAddress | null) => string;
     getFormControlItems: (controlIndex: number, sheetIndex?: number) => string[];
     getSheetFormControls: (sheetIndex?: number) => XlsxFormControl[];
-    mergeSelection: () => void;
+    mergeSelection: (mode?: XlsxMergeMode) => void;
     pasteFromClipboard: () => Promise<boolean>;
     pasteStructuredClipboardData: (payload: string) => boolean;
     pasteText: (text: string) => boolean;
@@ -1586,8 +1625,18 @@ interface XlsxViewerProps extends UseXlsxViewerControllerOptions {
     onFormControlAction?: (event: XlsxFormControlActionEvent) => void;
     /** Called after the built-in editor persists a checkbox, radio, list, dropdown, scrollbar, or spinner change. */
     onFormControlChange?: (event: XlsxFormControlChangeEvent) => void;
-    /** Replaces the chart loading placeholder. */
+    /** Replaces the loading placeholder for chart metadata, chart rendering code, and map geometry. */
     renderChartLoading?: (props: XlsxChartLoadingRenderProps) => React.ReactNode;
+    /** Replaces menu contents. Use runAction for built-in commands and closeMenu after custom commands. */
+    renderContextMenu?: (props: XlsxContextMenuRenderProps) => React.ReactNode;
+    /** Enables worksheet right-click and keyboard context menus. Defaults to true. */
+    enableContextMenu?: boolean;
+    /** Class applied to the portaled menu container. */
+    contextMenuClassName?: string;
+    /** Styles applied to the portaled menu container. */
+    contextMenuStyle?: React.CSSProperties & {
+        [property: `--${string}`]: string | number | undefined;
+    };
     /**
      * Replaces built-in worksheet form-control rendering.
      * Apply `style` to the custom root and use `stopPropagation` on pointer/click handlers.
@@ -1719,4 +1768,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
 declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
 declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
 
-export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };
+export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxContextMenuAction, type XlsxContextMenuActionId, type XlsxContextMenuContext, type XlsxContextMenuRenderProps, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxMergeMode, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };

package/dist/index.d.ts

@@ -149,6 +149,7 @@ interface XlsxCellRange {
     end: XlsxCellAddress;
     start: XlsxCellAddress;
 }
+type XlsxMergeMode = "cells" | "center" | "across";
 interface XlsxParsedRange {
     kind: "cells" | "rows" | "columns";
     range: XlsxCellRange;
@@ -718,6 +719,7 @@ interface XlsxChartAxis {
     max?: number;
     min?: number;
     majorGridlines?: boolean;
+    majorGridlineColor?: string;
     majorTickMark?: string;
     minorUnit?: number;
     minorGridlines?: boolean;
@@ -864,6 +866,7 @@ interface XlsxChart {
     varyColors?: boolean;
     view3d?: {
         depthPercent?: number;
+        heightPercent?: number;
         perspective?: number;
         rAngAx?: boolean;
         rotX?: number;
@@ -934,6 +937,8 @@ interface XlsxChartLoadingRenderProps {
     defaultNode: React.ReactNode;
     /** The chart rectangle in viewer pixels, including the current zoom level. */
     rect: XlsxImageRect;
+    /** Identifies whether chart metadata, rendering code, or map geometry is loading. */
+    stage?: "metadata" | "renderer" | "map";
 }
 interface XlsxFileTooLargeRenderProps {
     /** The built-in file-too-large message. */
@@ -1104,7 +1109,8 @@ interface XlsxViewerController {
     images: XlsxImage[];
     moveChartBy: (id: string, deltaX: number, deltaY: number) => void;
     shapes: XlsxShape[];
-    mergeSelection: () => void;
+    /** Merges the selection; defaults to preserving its existing alignment. */
+    mergeSelection: (mode?: XlsxMergeMode) => void;
     maxZoomScale: number;
     minZoomScale: number;
     moveImageBy: (id: string, deltaX: number, deltaY: number) => void;
@@ -1245,6 +1251,39 @@ interface XlsxViewerZoom {
     zoomOut: () => void;
     zoomScale: number;
 }
+type XlsxContextMenuActionId = "cut" | "copy" | "paste" | "clearContents" | "editCell" | "undo" | "redo" | "mergeCells" | "mergeAndCenter" | "mergeAcross" | "unmergeCells" | "sortAscending" | "sortDescending" | "selectRow" | "selectColumn" | "selectAll";
+interface XlsxContextMenuAction {
+    id: XlsxContextMenuActionId;
+    label: string;
+    shortcut?: string;
+    disabled?: boolean;
+    destructive?: boolean;
+    separatorBefore?: boolean;
+}
+interface XlsxContextMenuContext {
+    kind: "cell" | "row" | "column" | "sheet";
+    cell: XlsxCellAddress;
+    selection: XlsxCellRange;
+    sheetIndex: number;
+    sheetName: string;
+    readOnly: boolean;
+}
+interface XlsxContextMenuRenderProps {
+    context: XlsxContextMenuContext;
+    actions: XlsxContextMenuAction[];
+    /** Returns whether the command completed; failures remain visible in the menu. */
+    runAction: (actionId: XlsxContextMenuActionId) => Promise<boolean>;
+    closeMenu: () => void;
+    /** Viewport coordinates. The menu container handles positioning and edge clamping. */
+    position: {
+        x: number;
+        y: number;
+    };
+    isDark: boolean;
+    busy: boolean;
+    error: string | null;
+    defaultNode: React.ReactNode;
+}
 interface XlsxViewerEditing {
     addSheet: (name?: string) => void;
     addFormControl: (input: XlsxFormControlInput, sheetIndex?: number) => number | null;
@@ -1260,7 +1299,7 @@ interface XlsxViewerEditing {
     getCellFormula: (cell?: XlsxCellAddress | null) => string;
     getFormControlItems: (controlIndex: number, sheetIndex?: number) => string[];
     getSheetFormControls: (sheetIndex?: number) => XlsxFormControl[];
-    mergeSelection: () => void;
+    mergeSelection: (mode?: XlsxMergeMode) => void;
     pasteFromClipboard: () => Promise<boolean>;
     pasteStructuredClipboardData: (payload: string) => boolean;
     pasteText: (text: string) => boolean;
@@ -1586,8 +1625,18 @@ interface XlsxViewerProps extends UseXlsxViewerControllerOptions {
     onFormControlAction?: (event: XlsxFormControlActionEvent) => void;
     /** Called after the built-in editor persists a checkbox, radio, list, dropdown, scrollbar, or spinner change. */
     onFormControlChange?: (event: XlsxFormControlChangeEvent) => void;
-    /** Replaces the chart loading placeholder. */
+    /** Replaces the loading placeholder for chart metadata, chart rendering code, and map geometry. */
     renderChartLoading?: (props: XlsxChartLoadingRenderProps) => React.ReactNode;
+    /** Replaces menu contents. Use runAction for built-in commands and closeMenu after custom commands. */
+    renderContextMenu?: (props: XlsxContextMenuRenderProps) => React.ReactNode;
+    /** Enables worksheet right-click and keyboard context menus. Defaults to true. */
+    enableContextMenu?: boolean;
+    /** Class applied to the portaled menu container. */
+    contextMenuClassName?: string;
+    /** Styles applied to the portaled menu container. */
+    contextMenuStyle?: React.CSSProperties & {
+        [property: `--${string}`]: string | number | undefined;
+    };
     /**
      * Replaces built-in worksheet form-control rendering.
      * Apply `style` to the custom root and use `stopPropagation` on pointer/click handlers.
@@ -1719,4 +1768,4 @@ declare function useXlsxViewerThumbnails(options?: UseXlsxViewerThumbnailsOption
 declare function XlsxViewer(props: XlsxViewerProps): react_jsx_runtime.JSX.Element;
 declare function DefaultXlsxToolbar(): react_jsx_runtime.JSX.Element;
 
-export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };
+export { DefaultXlsxToolbar, type UseXlsxViewerControllerOptions, type UseXlsxViewerThumbnailsOptions, type XlsxActiveCellOverlayRenderProps, type XlsxCellAddress, type XlsxCellAlignmentInput, type XlsxCellBorderEdgeInput, type XlsxCellBorderStyleInput, type XlsxCellFillStyleInput, type XlsxCellFontStyleInput, type XlsxCellGradientStopInput, type XlsxCellNumberFormatInput, type XlsxCellProtectionInput, type XlsxCellRange, type XlsxCellStyleColorInput, type XlsxCellStyleContext, type XlsxCellStyleInput, type XlsxChart, type XlsxChartAxis, type XlsxChartDataLabels, type XlsxChartElementSelection, type XlsxChartLoadingRenderProps, type XlsxChartReference, type XlsxChartSeries, type XlsxChartsheet, type XlsxContextMenuAction, type XlsxContextMenuActionId, type XlsxContextMenuContext, type XlsxContextMenuRenderProps, type XlsxDrawingLayout, XlsxFileSizeLimitExceededError, type XlsxFileTooLargeRenderProps, type XlsxFormControl, type XlsxFormControlActionEvent, type XlsxFormControlCaption, type XlsxFormControlCaptionInput, type XlsxFormControlCaptionRun, type XlsxFormControlChangeEvent, type XlsxFormControlInput, type XlsxFormControlKind, type XlsxFormControlKindInput, type XlsxFormControlPatch, type XlsxFormControlRenderProps, type XlsxFormControlSelectionMode, type XlsxFormControlState, type XlsxFormulaTarget, type XlsxHighlightRangeOptions, type XlsxImage, type XlsxImageAnchor, type XlsxImageRect, type XlsxImageRenderProps, type XlsxImageResizeHandlePosition, type XlsxImageSelectionRenderProps, type XlsxMergeMode, type XlsxParsedRange, type XlsxRangeHighlight, type XlsxScrollerRenderProps, type XlsxShape, type XlsxShapeFill, type XlsxShapeParagraph, type XlsxShapeStroke, type XlsxShapeTextBox, type XlsxShapeTextRun, type XlsxSheetData, type XlsxSheetThumbnail, type XlsxSheetThumbnailResolution, type XlsxSheetVisibility, type XlsxTable, type XlsxTableColumn, type XlsxTableHeaderMenuRenderProps, type XlsxTableSortDirection, type XlsxTableSortState, type XlsxThemePalette, XlsxViewer, type XlsxViewerCharts, type XlsxViewerController, type XlsxViewerEditing, type XlsxViewerImages, type XlsxViewerProps, XlsxViewerProvider, type XlsxViewerProviderProps, type XlsxViewerSelection, type XlsxViewerTables, type XlsxViewerThumbnails, type XlsxViewerZoom, type XlsxWasmSource, type XlsxWorkbookTab, initWasm, parseXlsxRange, setWasmSource, useXlsxViewer, useXlsxViewerCharts, useXlsxViewerController, useXlsxViewerEditing, useXlsxViewerImages, useXlsxViewerSelection, useXlsxViewerTables, useXlsxViewerThumbnails, useXlsxViewerZoom };