配置项

Umo Viewer 默认配置，您可以访问 https://www.umodoc.com/demo?target=viewer 来在线修改和实时预览部分配置。

所有配置

{
  lang: 'zh-CN',
  theme: 'light',
  title: undefined,
  content: undefined,
  meta: [],
  cdnUrl: 'https://unpkg.com/@umoteam/editor-external@latest',
  showHeader: true,
  showAside: false,
  editable: false,
  printable: true,
  closeable: false,
  shareUrl: undefined,
  fitWidth: false,
  needPassword: false,
}

配置说明

lang

说明: 默认语言，可选值：zh-CN, en-US。

类型: string

默认值: zh-CN

是否必填: 否

theme

说明: 默认主题，可选值：light, dark, auto。

类型: string

默认值: light

是否必填: 否

title

说明: 文档标题。

类型: string

是否必填: 否

content

说明: 要预览的文档内容，在 Umo Editor 中，可以通过 getVanillaHTML 方法获取要预览的文档内容。

类型: string

默认值: undefined

是否必填: 是

meta

说明: 文档元信息，可用于展示额外的文档信息，每个元信息项包含 label 和 content 两个属性，默认值为 []。

类型: object[]

默认值: []

是否必填: 否

示例:

meta: [
  {
    label: '作者',
    content: 'Umo Team',
  },
  {
    label: '简介',
    content: 'Umo Viewer 是一款 PDF 文档查看器，同时也支持预览富文本内容',
  },
  {
    label: '创建时间',
    content: '2025-09-01 00:00:00',
  },
  // ……
]

cdnUrl

说明: 第三方资源（如 ECharts 图表）的 CDN 地址，详见 Umo Editor 配置项中的 cdnUrl 配置项。

类型: string

默认值: https://unpkg.com/@umoteam/editor-external@latest

是否必填: 否

showHeader

说明: 是否显示顶部导航栏。

类型: boolean

默认值: true

是否必填: 否

showAside

说明: 默认是否展开左侧边栏，左侧边栏主要用于显示文档缩略图、文档大纲以及文档元信息等。

类型: boolean

默认值: false

是否必填: 否

editable

说明: 是否可编辑，默认值为 false，如果配置为 true，则需要配置onEdit 事件。

类型: boolean

默认值: false

是否必填: 否

printable

说明: 是否可打印，默认值为 true。

类型: boolean

默认值: true

是否必填: 否

closeable

说明: 是否显示关闭按钮，默认值为 false，如果配置为 true，则会在顶部导航栏显示一个关闭按钮，此时需要配置onClose 事件。

类型: boolean

默认值: false

是否必填: 否

shareUrl

说明: 文档分享 URL，默认值为 undefined，如果未配置该项，则不会显示分享按钮。

类型: string

默认值: undefined

fitWidth

说明: 是否自动调整文档宽度，默认值为 false。

类型: boolean

默认值: false

是否必填: 否

needPassword

说明: 是否需要输入密码才能访问文档，默认值为 false。如果配置为 true，则需要配置 onValidatePassword 事件。

类型: boolean

默认值: false

是否必填: 否