UI Overview

@univerjs-pro/pdfs-ui mounts PDF units in the standard Univer workbench and is licensed through Univer Office SDK.

Package responsibilities

UniverPdfsUIPlugin depends on UniverLicensePlugin and UniverPdfsPlugin. Complete the licensed PDF setup before registering the UI plugin.

Register the UI plugin

import { UniverPdfsUIPlugin } from '@univerjs-pro/pdfs-ui'import PdfsUIEnUS from '@univerjs-pro/pdfs-ui/locale/en-US'import '@univerjs-pro/pdfs-ui/lib/index.css'univer.registerPlugin(UniverPdfsUIPlugin)

Merge PdfsUIEnUS into the locales passed to new Univer(...). The locale pack translates PDF-specific ribbon, inspector, context-menu, and page-rail labels.

Viewer and editor modes

The plugin always mounts the page-thumbnail rail, PDF canvas, and footer. Editing is enabled by default and additionally registers the ribbon, context menus, inspector, clipboard, insertion commands, and editing actions and controllers.

Use viewer-only mode when the current application must not expose those editing controls:

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

This option changes the mounted UI and editing-specific controllers and services. It is not an authorization policy and does not alter a saved PDF snapshot.

Thumbnail worker

thumbnailWorkerURL accepts a string, URL, or existing Worker. The referenced module must start the exported worker runtime:

import { startPdfPageThumbnailWorker } from '@univerjs-pro/pdfs-ui'startPdfPageThumbnailWorker()

univer.registerPlugin(UniverPdfsUIPlugin, {  thumbnailWorkerURL: new URL('./pdf-thumbnail-worker.js', import.meta.url),})

The worker requires a dedicated Worker scope. If no worker is configured, the browser lacks the required APIs, or a page needs a main-thread-only resource, thumbnail rendering uses the main thread.

Public API boundary

The UI invokes PDF commands and services internally. A ribbon button does not imply a matching public method. Use the PDF Facade guide for supported programmatic editing, Import and export for conversion, and Print for browser printing.

Menu order and grid layout

Use order, gridLayout, and updateMenuConfig() to configure tab, group, and item order, grid placement, and runtime updates. The guide also links to the custom-menu Facade options.