Collaboration
Plugins Info
Let users open the same Base and edit tables, fields, records, and views together. They can work in different views while changing the same document.
Integration steps
- Follow Collaboration integration to run the collaboration example and connect login, permissions, and database storage.
- Add Collaboration Client configuration to your existing Bases editor. Follow Office Quick Start for browser setup, but create and store Bases documents instead of copying the example's Sheets data.
- Create the Base through your application backend and return its ID to the browser.
Open a server Base
TypeScript
import '@univerjs-pro/bases/facade'import '@univerjs-pro/collaboration-client/facade'const base = await univerAPI.getCollaboration().loadBaseAsync('your-base-id')if (!base) throw new Error('Base could not be loaded')Reuse the ID when reopening or sharing the document. Do not replace server loading with createBase() and a new local blank document.
Verify synchronization and saving
Open the same ID in two independent browser sessions. Add a record or change a field in one and confirm the other receives it. Check that edits survive refresh and server restart.
Authorize viewers and unauthorized users on the server. Local read-only settings only control editor behavior. Exchange, comments, and history need their respective backend features; see Import and export, Comments, and history.
How is this guide?