Collaboration

Collaborative editing connects your browser editor to a backend. Start with Collaboration integration to run the example and connect your application's identity, permissions, and storage. See Collaboration Quick Start for the browser and server configuration.

Create the document through an authenticated application API, then load the returned Unit identifier with the method below. Reuse that identifier when opening the same document again.

Choose who loads the document

By default, UniverCollaborationClientUIPlugin reads the unit and type URL query parameters and loads the document on startup. If your application chooses the document and calls the Facade loader itself, set enableUrlUnitLoader: false during initialization so only the application initiates loading.

Merge the options below into your existing plugin registration or collaboration preset call. In preset mode, add collaborationPreset to the existing createUniver() presets list alongside your editor presets.

import { UniverCollaborationClientUIPlugin } from '@univerjs-pro/collaboration-client-ui'univer.registerPlugin(UniverCollaborationClientUIPlugin, {  enableUrlUnitLoader: false,})

import { UniverSheetsCollaborationPreset } from '@univerjs/preset-sheets-collaboration'const collaborationPreset = UniverSheetsCollaborationPreset({  universerEndpoint: 'https://your-backend.example.com',  enableUrlUnitLoader: false,})

This disables automatic URL loading while keeping collaborative editing and explicit Facade loading available.

Facade API

import '@univerjs-pro/collaboration-client/facade'const collaboration = univerAPI.getCollaboration()const unit = await collaboration.loadSheetAsync('your-unit-id')

Node.js / AI SDK · OT