Univer PDFs
Univer PDFs provides a browser PDF viewer and editor with durable document data, Facade APIs, import and export, collaboration, and printing.
What is Univer PDFs
Univer PDFs is the PDF product in Web SDK. It represents a PDF as a formal UNIVER_PDF unit, preserves the imported source document, and stores accepted edits in a separate durable edit layer. The browser UI renders both layers as one continuous document.
Use Univer PDFs when an application needs to create or open PDFs, add editable content, preserve imported PDF fidelity, collaborate on changes, export the result, or hand the active document to the browser print workflow.
Plugin mode only
There is no PDF preset package. Register the PDF model, UI, and optional feature plugins explicitly.
Browser Compatibility
Web SDK is compiled with a target of Chrome 88, but this does not mean it fully supports all mainstream environments. We strive to ensure Web SDK works well in the following browsers and Node.js environments:
| Edge | Firefox | Chrome | Safari | Electron |
|---|---|---|---|---|
| >=88 | >=90 | >=88 | >=14.1 | >=12 |
Web SDK relies on Intl.Segmenter. If your browser or runtime environment does not support it, please add a
corresponding polyfill first. We recommend using @formatjs/intl-segmenter.
If you encounter compatibility issues, please first try to resolve them using the appropriate polyfills. If the issue persists, feel free to submit an issue.
Node.js Compatibility
Note: This only applies to running Web SDK in a Node.js environment and does not apply to cases where Web SDK is run in a browser using build tools based on Node.js.
Web SDK can run in a Node.js environment, supporting versions v18.17.0 and later.
Highlights
- PDF unit model: Stores the source document, page structure, resources, and durable editing intent in
IPdfUnitData. - Page and element operations: Supports page navigation and insertion plus editable text, lists, tables, images, dividers, and annotations.
- Browser workbench: Renders PDF pages, thumbnails, selection, editing controls, clipboard behavior, and the inspector UI.
- Command pipeline: Applies accepted changes through durable commands and mutation batches so save, undo, and redo share one model.
- Facade API: Creates, finds, edits, and saves PDF units through application-facing PDF, page, element, and native-text objects.
How to Read the Documentation
On the left side of the screen, you’ll find the docs navbar. The pages of the docs are organized sequentially, from basic to advanced, so you can follow them step-by-step when building your application. However, you can read them in any order or skip to the pages that apply to your use case. You can also checkout Univer PDFs at the top of the sidebar.
On the right side of the screen, you’ll see a table of contents that makes it easier to navigate between sections of a page. If you need to quickly find a page, you can use the search bar at the top, or the search shortcut (Ctrl+K or Cmd+K).
To get started, check out the Quick Start guide.
Pre-Requisite Knowledge
Although our docs are designed to be beginner-friendly, we need to establish a baseline so that the docs can stay focused on Web SDK.
To get the most out of our docs, it’s recommended that you have a basic understanding of JavaScript and its ecosystem.
If you are interested in running Web SDK on Node.js, you should also have a basic understanding of Node.js.
If you would like to try Web SDK and deploy Univer Server, we recommend that you have a basic understanding of Linux, Docker and Docker Compose (or Kubernetes).
Extend Univer PDFs
Web SDK is designed to be highly extensible so you can shape it to fit your needs.
How is this guide?