Univer Docs
Univer Docs is the document component of Univer SDK, supporting both browser and Node.js, with flexible, extensible, and customizable features.
What is Univer Docs
Univer SDK is a full-stack framework to build productivity applications, and Univer Docs is the document component of Univer SDK.
Univer Docs can both run in the browser and on the server (Node.js). It is designed to be highly flexible, extensible and customizable, and can be used to build a wide range of applications, from simple text entry to complex typesetting. Whether you’re an individual developer or part of a team, Univer Docs can help you build powerful document-based applications quickly and easily.
Browser Compatibility
Univer SDK is compiled with a target of Chrome 88, but this does not mean it fully supports all mainstream environments. We strive to ensure Univer SDK works well in the following browsers and Node.js environments:
| Edge | Firefox | Chrome | Safari | Electron |
|---|---|---|---|---|
| >=88 | >=90 | >=88 | >=14.1 | >=12 |
Univer 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 Univer SDK in a Node.js environment and does not apply to cases where Univer SDK is run in a browser using build tools based on Node.js.
Univer SDK can run in a Node.js environment, supporting versions v18.17.0 and later.
Highlights
Univer Docs now supports a wide range of features, including:
- Basic document features: Full text typesetting, including paragraph settings, spacing before and after paragraphs, paragraph alignment, indentation and hanging, as well as typesetting capabilities within paragraphs such as punctuation compression, punctuation hanging, character spacing, and Western word breaking.
- Header and footer
- Floating images
- Hyperlinks
- and more...
For more details, please refer to the pages under the Features section. The core and major features are open-sourced on GitHub and are free to use.
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 Docs 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 Univer 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 Univer SDK on Node.js, you should also have a basic understanding of Node.js.
If you would like to try Univer SDK Pro and deploy Univer Server, we recommend that you have a basic understanding of Linux, Docker and Docker Compose (or Kubernetes).
Extend Univer Docs
Univer SDK is designed to be highly extensible so you can shape it to fit your needs.
How is this guide?