ooxml-excel-editor 1.1.0

package/dist/react/ExcelViewer.d.ts

@@ -0,0 +1,153 @@
+import { CSSProperties } from 'react';
+import { CellModel, CellStyleFn, CellStyleOverride, ImageAnchor, MergeRange, TransformModelFn, WorkbookModel } from '../core/model/types';
+import { FormulaEngineFactory } from '../core/formula/engine';
+import { CellChangePayload, DimChangePayload, DirtyChangePayload, ImageChangePayload, StructChangePayload } from '../core/edit/edit-controller';
+import { CellSnapshot } from '../core/model/snapshot';
+import { CellValue, getCellValue, getSheetData, getRangeData, sheetToJSON, ReadOptions, SheetToJSONOptions } from '../core/model/data-access';
+import { EditorResolver } from '../core/edit/editor-context';
+import { ViewerTheme } from '../core/render/theme';
+import { ExcelSource } from '../core/loader';
+import { ImageExportOptions, PdfExportOptions, PrintOptions } from '../core/export';
+import { XlsxExportOptions } from '../core/export/xlsx-writer';
+import { Cell } from '../core/viewer/controller';
+import { ExcelPlugin } from '../core/plugin';
+export interface ExcelViewerProps {
+    src?: ExcelSource;
+    fileName?: string;
+    theme?: Partial<ViewerTheme>;
+    /** 单击超链接是否自动打开(默认 true) */
+    openLinks?: boolean;
+    transformModel?: TransformModelFn;
+    cellStyle?: CellStyleFn;
+    /** 插件(与 Vue 通用):theme/transformModel/cellStyle/events/overlay/setup 全跨框架可用 */
+    plugins?: ExcelPlugin[];
+    /** 编辑总开关:默认 false = 只读(行为不变)。开启后才能进入编辑(E0:闸门) */
+    editable?: boolean;
+    /** 按格只读判定:返回 true = 只读(cell 为空格时传 null) */
+    cellReadOnly?: (cell: CellModel | null, pos: {
+        row: number;
+        col: number;
+    }) => boolean | void;
+    /** 只读区域(0-based 闭区间);命中即只读 */
+    readOnlyRanges?: MergeRange[];
+    /** 自定义单元格编辑器(按格返回工厂;覆盖插件 editor)。需 editable 开启 */
+    editor?: EditorResolver;
+    /** 公式重算(E4):默认 false 沿用缓存值。开启后编辑公式/被引用格 → 依赖格自动重算。需 editable */
+    recalc?: boolean;
+    /** 自定义/自研公式引擎工厂(可换引擎);不给则用默认 HyperFormula(需 npm i hyperformula) */
+    formulaEngine?: FormulaEngineFactory;
+    className?: string;
+    style?: CSSProperties;
+    onRendered?: (wb: WorkbookModel) => void;
+    onError?: (msg: string) => void;
+    onCellClick?: (p: {
+        row: number;
+        col: number;
+        text: string;
+    }) => void;
+    onCellDblClick?: (p: {
+        row: number;
+        col: number;
+        text: string;
+    }) => void;
+    onSelectionChange?: (p: {
+        range: MergeRange;
+        active: Cell;
+    }) => void;
+    onHyperlinkClick?: (p: {
+        url: string;
+        cell: Cell;
+    }) => void;
+    onSheetChange?: (p: {
+        index: number;
+        name: string;
+    }) => void;
+    /** 单元格变更(编辑/撤销/重做;含前后完整快照) */
+    onCellChange?: (p: CellChangePayload) => void;
+    onEditStart?: (p: unknown) => void;
+    onEditCommit?: (p: unknown) => void;
+    /** 列宽/行高变更(拖拽/autofit/API/撤销重做;前后 px 尺寸) */
+    onDimChange?: (p: DimChangePayload) => void;
+    /** 脏状态变更(有/无未保存修改) */
+    onDirtyChange?: (p: DirtyChangePayload) => void;
+    /** 图片增删移改(前后 ImageAnchor) */
+    onImageChange?: (p: ImageChangePayload) => void;
+    /** 行列结构变更(增删行列) */
+    onStructChange?: (p: StructChangePayload) => void;
+}
+/** 命令式句柄(与 Vue ref / ViewerApi 对齐) */
+export interface ExcelViewerHandle {
+    load: (src: ExcelSource) => void;
+    getWorkbook: () => WorkbookModel | null;
+    getActiveSheet: () => number;
+    setActiveSheet: (i: number) => void;
+    getSelection: () => MergeRange | null;
+    setSelection: (range: MergeRange) => void;
+    rectOf: (row: number, col: number) => {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    } | null;
+    rectOfRange: (range: MergeRange) => {
+        x: number;
+        y: number;
+        w: number;
+        h: number;
+    } | null;
+    redraw: () => void;
+    isCellEditable: (row: number, col: number) => boolean;
+    editCell: (row: number, col: number, value: CellValue) => boolean;
+    editRange: (range: MergeRange, values: CellValue[][]) => boolean;
+    clearRange: (range: MergeRange) => boolean;
+    setStyle: (range: MergeRange, patch: CellStyleOverride) => boolean;
+    getImages: () => ImageAnchor[];
+    addImage: (anchor: ImageAnchor) => number;
+    removeImage: (index: number) => boolean;
+    moveImage: (index: number, dxPx: number, dyPx: number) => boolean;
+    resizeImage: (index: number, widthPx: number, heightPx: number) => boolean;
+    insertRows: (at: number, count?: number) => boolean;
+    deleteRows: (at: number, count?: number) => boolean;
+    insertCols: (at: number, count?: number) => boolean;
+    deleteCols: (at: number, count?: number) => boolean;
+    undo: () => void;
+    redo: () => void;
+    canUndo: () => boolean;
+    canRedo: () => boolean;
+    getEditingCell: () => {
+        row: number;
+        col: number;
+    } | null;
+    getCellSnapshot: (row: number, col: number) => CellSnapshot | null;
+    beginEdit: (row: number, col: number) => boolean;
+    cancelEdit: () => void;
+    isEditing: () => boolean;
+    setColumnWidth: (col: number, width: number) => boolean;
+    setRowHeight: (row: number, height: number) => boolean;
+    isRecalcReady: () => boolean;
+    isDirty: () => boolean;
+    resetToOriginal: () => boolean;
+    exportImage: (opts?: ImageExportOptions) => Promise<Blob>;
+    downloadImage: (opts?: ImageExportOptions) => Promise<void>;
+    exportPdf: (opts?: PdfExportOptions) => Promise<Blob>;
+    downloadPdf: (opts?: PdfExportOptions) => Promise<void>;
+    print: (opts?: PrintOptions) => Promise<void>;
+    exportXlsx: (opts?: XlsxExportOptions) => Promise<Blob>;
+    downloadXlsx: (opts?: XlsxExportOptions) => Promise<void>;
+    exportJson: (opts?: SheetToJSONOptions) => string;
+    downloadJson: (opts?: SheetToJSONOptions) => void;
+    exportCsv: (opts?: {
+        target?: number;
+        format?: boolean;
+    }) => string;
+    downloadCsv: (opts?: {
+        target?: number;
+        format?: boolean;
+    }) => void;
+    getCellValue: (row: number, col: number, sheet?: number) => ReturnType<typeof getCellValue>;
+    getCellText: (row: number, col: number, sheet?: number) => string;
+    getSheetData: (opts?: ReadOptions, sheet?: number) => ReturnType<typeof getSheetData>;
+    getSheetJSON: (opts?: Parameters<typeof sheetToJSON>[1], sheet?: number) => ReturnType<typeof sheetToJSON>;
+    getRangeData: (range: MergeRange, opts?: ReadOptions, sheet?: number) => ReturnType<typeof getRangeData>;
+}
+export declare const ExcelViewer: import('react').ForwardRefExoticComponent<ExcelViewerProps & import('react').RefAttributes<ExcelViewerHandle>>;

package/dist/react/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * React 入口。其它 React 项目这样用:
+ *   import { ExcelViewer } from 'ooxml-excel-editor/react'
+ *   import 'ooxml-excel-editor/react/style.css'   // (打包后)
+ *
+ * 与 Vue 版共用同一套 core 引擎(ViewerController + 解析/渲染/导出)。
+ */
+export { ExcelViewer } from './ExcelViewer';
+export type { ExcelViewerProps, ExcelViewerHandle } from './ExcelViewer';
+export { useExcelDocument } from './use-excel-document';
+export type { ExcelDocument } from './use-excel-document';

package/dist/react/use-excel-document.d.ts

@@ -0,0 +1,17 @@
+import { TransformModelFn, WorkbookModel } from '../core/model/types';
+import { ParseProgress } from '../core/progress';
+import { ExcelSource } from '../core/loader';
+export interface ExcelDocument {
+    loading: boolean;
+    error: string | null;
+    workbook: WorkbookModel | null;
+    progress: ParseProgress | null;
+    load: (src: ExcelSource, transform?: TransformModelFn) => Promise<void>;
+    /** 原始字节(高保真 overlay 导出用) */
+    sourceBuffer: ArrayBuffer | null;
+}
+/**
+ * React 版文档加载 hook —— 与 Vue 的 useExcelDocument 同逻辑(共用 core 的 loader/finalize/worker)。
+ * 解析走 worker(大文件不卡),按文件头给友好错误,完成后 finalizeImages 落 blob url。
+ */
+export declare function useExcelDocument(): ExcelDocument;

package/dist/react.d.ts

@@ -0,0 +1,2 @@
+export * from './react/index'
+export {}