Univer Bases
Univer Bases provides a structured data workspace with tables, fields, records, formulas, and multiple views.
What is Univer Bases
Univer Bases is the structured data product in Univer SDK Pro. It is designed for applications where the primary object is a set of records instead of a worksheet grid: lightweight databases, content workflows, approval trackers, CRM-style tables, and internal tools are good fits.
Bases is an independent Univer SDK unit type. The core package owns tables, fields, records, views, formula calculation, search, commands, and collaboration mutations. The UI package renders the standalone workbench and the built-in views.
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
- Tables, fields, and records: Store typed fields and ordered records in each table.
- Multiple views: Project the same records through grid, Kanban, calendar, Gantt, and gallery views.
- Command-driven editing: Route model changes through one command layer with permissions and hooks for optional history and collaboration integrations.
- Formula fields: Connect Base fields to the Univer SDK formula calculation pipeline.
- Browser workbench: Render views and provide selection, editing, clipboard, scrolling, and panels.
- Persistence: Create, restore, and save an
IBaseSnapshotwithout mutating the running snapshot directly.
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 Bases 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 Bases
Univer SDK is designed to be highly extensible so you can shape it to fit your needs.
How is this guide?