开发文档Umo Editor Next模板管理

模板管理

Umo Editor Next 提供了模板管理功能,您可以在 Umo Editor Next 中创建、管理和使用文档模板。

效果截图

Umo Editor 模板管理

使用场景

  • 合同/制度/报告等标准化文档:统一结构与排版,减少重复搭建
  • 企业制度库:按分类维护模板,分部门复用同一套规范
  • 表单式录入:用模板定义固定字段与段落,占位后快速填写
  • 多角色协作:模板制定人与填写人分工,降低误改与漏填
  • 交付文档生产:用模板保证导出格式稳定(Word/PDF/图片)
  • 长期迭代的模板体系:通过版本与修订让每次改动可追溯

与其他功能协同使用

  • 内容锁定(locked):锁定模板骨架与关键条款,只开放可编辑区域
  • 修订(revision):模板维护阶段开启修订,审阅通过后再发布模板
  • 历史版本(versions):为模板或关键文档保存里程碑版本,便于回溯对比
  • 导入(import):把存量 Word/Office 文档导入后整理成模板
  • 评论(comments):对模板条款/填写规范用评论线程讨论并沉淀结论

配置项示例

const defaultOptions = {
  // 模板的相关配置项
  template: {
    categories: [],
    async onList() {},
    async onGet() {},
    async onCreate() {},
    async onUpdate() {},
    async onDelete() {},
  },
}

配置项说明

template.categories

说明:模板分类列表,您可以根据需要自定义模板分类,每个分类为一个对象,包含分类名称和分类 ID。

类型Array

默认值[]

示例[{ label: '示例分类', value: '1' }]

template.onList

说明:获取模板列表的异步方法,您需要在该方法中返回模板列表。

类型Async Function

参数Object

  • pageIndex:当前页码,从 1 开始。
  • pageSize:每页模板数量,默认值为 10。
  • keyword:搜索关键词,根据关键词搜索模板名称。
  • category:分类的 value 值,见 template.categories,根据分类 value 筛选模板。

返回值:见 Umo Editor Server 中的 文档模板示例接口 中的对应示例接口。

template.onGet

说明:获取模板详情的异步方法,您需要在该方法中返回模板详情,返回示例见 Umo Editor Server 中的 文档模板示例接口

类型Async Function

参数String

  • id:模板 ID,根据 ID 获取模板详情。

返回值:见 Umo Editor Server 中的 文档模板示例接口 中的对应示例接口。

template.onCreate

说明:创建模板的异步方法,您需要在该方法中创建模板并返回模板详情,返回示例见 Umo Editor Server 中的 文档模板示例接口

类型Async Function

参数Object,要创建的模板内容。

返回值:见 Umo Editor Server 中的 文档模板示例接口 中的对应示例接口。

template.onUpdate

说明:更新模板的异步方法,您需要在该方法中更新模板并返回模板详情,返回示例见 Umo Editor Server 中的 文档模板示例接口

类型Async Function

参数Object

  • id:模板 ID,根据 ID 更新模板。
  • data:要更新的模板内容。

返回值:见 Umo Editor Server 中的 文档模板示例接口 中的对应示例接口。

template.onDelete

说明:删除模板的异步方法,您需要在该方法中删除模板并返回删除结果,返回示例见 Umo Editor Server 中的 文档模板示例接口

类型Async Function

参数String

  • id:模板 ID,根据 ID 删除模板。

返回值:见 Umo Editor Server 中的 文档模板示例接口 中的对应示例接口。