@offilite/assets
v1.0.0
Published
Static assets for ONLYOFFICE local editor - web-apps, sdkjs, wasm, and icons
Maintainers
Readme
@offilite/assets
ONLYOFFICE 本地编辑器的静态资源包。
安装
# 必须安装
npm install @offilite/assets
# 可选:字体文件(约 81MB)
npm install @offilite/assets-fonts简介
此包包含 ONLYOFFICE 编辑器的全部运行时静态资源:
web-apps/— 编辑器 API 和主应用sdkjs/— ONLYOFFICE SDK JavaScriptwasm/— WebAssembly 文档转换引擎img/— 图标和文档格式图像standard-fonts/— 标准字体目录
使用方式
方式一:Vite 插件(推荐)
// vite.config.ts
import { defineConfig } from 'vite'
import { vitePluginOffiliteAssets } from '@offilite/assets/vite'
export default defineConfig({
plugins: [
vitePluginOffiliteAssets({
fonts: true, // 需要安装 @offilite/assets-fonts
target: 'public', // 目标目录,默认为 'public'
}),
],
})Vite 插件会在开发服务器启动和构建时自动将资源复制到 public/ 目录。
方式二:CLI 命令
# 复制基础资源
npx offilite-assets copy --target ./public
# 同时复制字体
npx offilite-assets copy --target ./public --with-fonts方式三:编程方式
import { getAssetsPath, getFontsPath, ASSET_DIRS } from '@offilite/assets'
// 获取资源目录路径
const assetsPath = getAssetsPath()
console.log('Assets:', assetsPath) // 如: /path/to/node_modules/@offilite/assets/assets
// 获取字体目录路径(如果已安装)
const fontsPath = getFontsPath()
console.log('Fonts:', fontsPath)资源目录结构
node_modules/@offilite/assets/assets/
├── web-apps/ # 编辑器 API 脚本
│ └── apps/
│ ├── api/
│ ├── common/
│ ├── documenteditor/
│ ├── presentationeditor/
│ └── spreadsheeteditor/
├── sdkjs/ # ONLYOFFICE SDK
│ ├── cell/
│ ├── common/
│ ├── slide/
│ └── word/
├── wasm/ # WebAssembly 转换引擎
│ └── x2t/
│ ├── x2t.js
│ └── x2t.wasm
├── img/ # 图标
│ ├── doc-formats/
│ └── icon/
└── standard-fonts/ # 标准字体(空目录)重要约束
web-apps/ 和 sdkjs/ 必须保持同级目录结构,因为编辑器内部代码使用 ../../../../sdkjs/... 这样的相对路径引用。此包已确保目录结构正确。
许可证
MIT
