# excel-editor-ui

**Repository Path**: wanghe520/excel-editor-ui

## Basic Information

- **Project Name**: excel-editor-ui
- **Description**: 开箱即用的Excel编辑 UI，于docx-editor-ui页面风格一致
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-04-02
- **Last Updated**: 2026-07-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Excel, excel-editor, editor, 表格编辑器, 在线表格编辑器

## README

# Excel Editor UI

## 快速开始（仅对象式接入）

```ts
import { ExcelEditor } from '@wanghe1995/excel-editor-ui'

const editor = new ExcelEditor({
  container: '#app',
  initialContent: null,
  documentName: '示例表格.xlsx',
  readOnly: false,
  onChange: (content) => {
    console.log('excel change', content)
  }
})
```

## 对外 API（仅对象式）

```ts
interface Options {
  container: string | HTMLElement
  initialContent?: any
  documentName?: string
  readOnly?: boolean
  locale?: ExcelLocale
  i18n?: Partial<ExcelI18nMessages>
  onChange?: (content: any) => void
}

class ExcelEditor {
  constructor(options: Options)
  setContent(content: any): void
  setDocumentName(name: string): void
  setReadOnly(readOnly: boolean): void
  destroy(): void
}
```

## 说明

- 统一采用 `new ExcelEditor(...)` 接入。
- 宿主负责数据请求与持久化；编辑器仅负责渲染与变更回调。