UI 概览

配置 PDF Canvas、编辑器控件、语言包和缩略图 Worker。

@univerjs-pro/pdfs-ui 将 PDF 单元挂载到 Univer 标准工作台中,并通过 Univer Office SDK 获得许可证。

包的职责

包职责
@univerjs-pro/pdfs注册 UNIVER_PDF 单元、文档模型和可持久化的 PDF 命令。
@univerjs-pro/pdfs-ui挂载浏览器 Canvas、缩略图栏和底栏;本地编辑控件默认启用。
@univerjs-pro/pdfs-editor声明协同侧的编辑器依赖,不挂载 PDF UI,也不控制 editor.enabled。

UniverPdfsUIPlugin 依赖 UniverLicensePlugin 和 UniverPdfsPlugin。请先完成带许可证的 PDF 基础配置,再注册 UI 插件。

注册 UI 插件

UniverPdfsUIPlugin

  • editor
    object
    启用 PDF 编辑器或 Slides 编辑器的控件。设为 false 时只显示内容。
    • enabled
      boolean默认值: true
      启用 PDF 编辑器或 Slides 编辑器的控件。设为 false 时只显示内容。
  • thumbnailWorkerURL
    string | URL | Worker
    在浏览器 Worker 中生成缩略图。
TypeScript
import { UniverPdfsUIPlugin } from '@univerjs-pro/pdfs-ui'import PdfsUIZhCN from '@univerjs-pro/pdfs-ui/locale/zh-CN'import '@univerjs-pro/pdfs-ui/lib/index.css'univer.registerPlugin(UniverPdfsUIPlugin)

将 PdfsUIZhCN 合并到传给 new Univer(...) 的语言包中。该语言包负责翻译 PDF 功能区、检查器、右键菜单和页面栏的文案。

查看和编辑模式

插件始终挂载页面缩略图栏、PDF Canvas 和底栏。编辑默认启用,并额外注册功能区、右键菜单、检查器、剪贴板、插入命令,以及编辑操作和控制器。

如果当前应用只需查看 PDF,可以关闭编辑控件:

TypeScript
univer.registerPlugin(UniverPdfsUIPlugin, {  editor: { enabled: false },})

该选项只改变已挂载的 UI,以及编辑专用的控制器和服务。它不是权限策略,也不会修改已保存的 PDF 快照。

缩略图 Worker

thumbnailWorkerURL 接受字符串、URL 或现有的 Worker。对应模块必须启动包导出的 Worker 运行时:

TypeScript
import { UniverPdfsUIWorkerPlugin } from '@univerjs-pro/pdfs-ui/worker'import { Univer } from '@univerjs/core'const univer = new Univer()univer.registerPlugin(UniverPdfsUIWorkerPlugin)
TypeScript
univer.registerPlugin(UniverPdfsUIPlugin, {  thumbnailWorkerURL: new URL('./pdf-thumbnail-worker.js', import.meta.url),})

该 Worker 必须运行在专用 Worker 作用域中。如果未配置 Worker、浏览器缺少所需 API,或页面依赖只能在主线程提供的资源,缩略图会在主线程渲染。

公共 API 边界

UI 会在内部调用 PDF 命令和服务。功能区中存在按钮并不代表存在对应的公共方法。支持的编程式编辑请参阅 PDF Facade 指南,格式转换请参阅导入导出,浏览器打印请参阅打印。

启动时,请在菜单配置中设置顺序和网格位置。如需修改已有菜单,请使用菜单 Facade API。

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.