API Reference

@univerjs/preset-sheets-collaboration

TypeScript
import { UniverSheetsCollaborationPreset } from '@univerjs/preset-sheets-collaboration'createUniver({  presets: [    UniverSheetsCollaborationPreset({      universerEndpoint: 'https://your-backend.example.com',      univerContainerId: 'app',    }),  ],})

The preset registers the collaboration model, browser client, client UI, and Sheets history UI in that order. It therefore adds realtime editing, collaboration UI, and spreadsheet version history as one composition.

universerEndpoint points to your application backend. Compose the required Univer Server SDK modules and expose their protocol routes there; the preset only registers browser plugins. Configure the History Service, Endpoint, storage, and permissions separately to enable version history.

Configuration

TypeScript
interface IUniverSheetsCollaborationPresetConfig {  universerEndpoint?: string  univerContainerId?: string  enableFrontendLog?: boolean  enableOfflineEditing?: boolean  enableSingleActiveInstanceLock?: boolean  historyWorkerURL?: string | URL | Worker}

How is this guide?

© 2026 DreamNum Co., Ltd.