@zhcw/document-editor
v1.0.7
Published
A web-based Office document editor component that supports Word, Excel, and PowerPoint files
Maintainers
Readme
OnlyOffice Web
🌐 在线体验: https://ranuts.github.io/document/
基于 OnlyOffice 的本地网页文档编辑器,让您直接在浏览器中编辑文档,无需服务器端处理,保护您的隐私安全。
✨ 主要特性
- 🔒 隐私优先: 所有文档处理都在浏览器本地进行,不上传到任何服务器
- 📝 多格式支持: 支持 DOCX、XLSX、PPTX 等多种文档格式
- ⚡ 实时编辑: 提供流畅的实时文档编辑体验
- 🚀 无需部署: 纯前端实现,无需服务器端处理
- 🎯 即开即用: 打开网页即可开始编辑文档
🛠️ 技术架构
本项目基于以下核心技术构建:
- OnlyOffice SDK: 提供强大的文档编辑能力
- WebAssembly: 通过 x2t-wasm 实现文档格式转换
- 纯前端架构: 所有功能都在浏览器中运行
📖 使用方法
基本使用
- 访问 在线编辑器
- 上传您的文档文件
- 直接在浏览器中编辑
- 下载编辑后的文档
作为组件库使用
import { DocumentEditor } from '@zhcw/document-editor';
const editor = new DocumentEditor({
containerId: 'document-preview',
mode: 'preview',
fileUrl: 'https://example.com/download/123',
fileName: 'example.doc',
maxFileSizeBytes: 60 * 1024 * 1024,
});
// 页面卸载时必须释放下载任务、事件监听器和 OnlyOffice 实例。
editor.destroy();OnlyOffice 运行时使用全局编辑器实例,同一 window 中只允许一个活动的 DocumentEditor;创建新实例会自动销毁并取消旧实例。preview 模式会同时设置 editorConfig.mode = "view" 和 permissions.edit = false。
📚 预览组件文档: https://chaxus.github.io/ran/src/ranui/preview/
🚀 部署说明
- 自动部署: 当代码推送到主分支时,项目会自动部署到 GitHub Pages
- 手动部署: 您也可以将项目部署到任何静态网站托管服务
🔧 本地开发
# 克隆项目
git clone https://github.com/sgidi-gis/onlyofficeDocument.git
# 进入项目目录
cd onlyofficeDocument
# 安装依赖
pnpm install
# 启动本地开发服务器
pnpm dev📚 参考资料
- onlyoffice-x2t-wasm - 基于 WebAssembly 的文档转换器
- se-office - 安全文档编辑器
- web-apps - OnlyOffice 网页应用
- sdkjs - OnlyOffice JavaScript SDK
- onlyoffice-web-local - 本地网页版 OnlyOffice 实现
🤝 贡献
欢迎提交 Issue 和 Pull Request 来帮助改进这个项目!
📄 许可证
详情请参阅 LICENSE 文件。
