工具栏配置

用于配置 Umo Editor 工具栏区域的显示和行为。

默认配置

{
  toolbar: {
    defaultMode: 'ribbon',
    // enableSourceEditor: true, v6.0.0 已移除
    menus: ['base', 'insert', 'table', 'tools', 'page', 'export'],
    disableMenuItems: [],
    importWord: {
      enabled: true,
      options: {},
      useCustomMethod: false,
      onCustomImportMethod() {},
    },
  },
}

配置项说明

toolbar.defaultMode

说明：工具栏的默认模式，配置后用户仍可自主切换模式，且会保存到本地，默认使用用户选择的工具栏模式，但您仍然可以通过setToolbar 方法来强制修改工具栏模式。

类型：String

默认值：ribbon

可选值：ribbon、classic

toolbar.enableSourceEditor

说明：是否启用编辑器源码模式，在编辑器源码模式下，用户可编辑源码，预览效果，适合具备编程能力的开发人员使用，不建议向普通用户开放。 v6.0.0 已移除

类型：Boolean

默认值：false

toolbar.menus

说明：要启用的工具栏菜单列表，默认全部启用，通过配置该项，可以禁用部分菜单，但是不支持禁用所有菜单且必须包含 base 菜单。

类型：Array

默认值：['base', 'insert', 'table', 'tools', 'page', 'export']

可选值：base、insert、table、tools、page、export

toolbar.disableMenuItems

说明：要禁用的菜单项，默认不禁用任何菜单项。

类型：Array

默认值：[]

可选值：highlight, ordered-list, bullet-list, task-list, line-height, margin, quote, code, select-all, markdown, print, link, image, video, audio, file, code-block, symbol, chineseDate, emoji, math, tag, columns, callout, mention, bookmark, hard-break, hr, toc, textBox, template, webPage, qrcode, barcode, signature, seal, diagrams, echarts, mermaid, chineseCase, …

toolbar.importWord

说明：导入 Word 文档的相关配置。v3.1.0 新增

类型：Object

默认值：

{
  enabled: true, 
  options: {},
  useCustomMethod: false,
  onCustomImportMethod: undefined
}

配置项：

• enabled：是否启用导入 Word 文件功能，默认为 true。
• options：Mammoth 的配置项 (options)，详情请见 Mammoth。
• useCustomMethod：是否使用自定义方法导入 Word 文件，可以通过配置该选项，使用自定义导入方法导入 Word 文件，默认为 false，如果为 true，则使用 onCustomImportMethod 方法导入 Word 文档。
• onCustomImportMethod：自定义导入 Word 文档的方法，如果要使用自定导入方法，需要配置 toolbar.importWord.useCustomMethod 选项为 true。

返回值：同 Mammoth.convertToHtml() 返回的数据格式，示例如下：

{
  value: '<p>Hello world</p>',
  messages: [
    {
      type: 'success', 
      message: 'Converted 1 paragraph',
    },
  ],
}