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 Web SDK. 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 Web 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
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
| Feature | Purpose |
|---|---|
| Fields and attachments | Text, numbers, choices, members, dates, and attachments. |
| Records, links, and hierarchy | Batch edits, local pagination, table links, and parent-child records. |
| Views | Grid, Kanban, Calendar, Gantt, Gallery, filtering, sorting, grouping, and conditional colors. |
| Formulas | Field calculations and explicitly configured cross-document references. |
| Permissions | Editing permissions for Bases, tables, fields, records, and views. |
| Import and export | Import Excel, CSV, and TSV, and export table data; requires a conversion backend. |
| Dashboards and pivot views | Summarize table data and combine charts, filters, text, and images. |
| Comments | Discuss records; shared discussions require a comment service. |
| Collaboration | Edit the same Base together; requires a collaboration service. |
| Edit history | Read server-stored versions and differences. |
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 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.
Extend Univer Bases
Web SDK is designed to be highly extensible so you can shape it to fit your needs.
How is this guide?