@univerjs-pro/collaboration-client-ui
Collaboration UI integration for Web SDK clients.
TypeScript
import { UniverCollaborationClientUIPlugin } from '@univerjs-pro/collaboration-client-ui'univer.registerPlugin(UniverCollaborationClientUIPlugin, {})Entry Points
- Facade:
@univerjs-pro/collaboration-client-ui/facade - Locale:
@univerjs-pro/collaboration-client-ui/locale/*
IUniverCollaborationClientUIConfig
TypeScript
import type { DependencyOverride } from '@univerjs/core'export interface IUniverCollaborationClientUIConfig { /** * Override internal modules with custom implementations. */ override?: DependencyOverride /** * Enable UI integrations that depend on Docs, such as document selections and image paste. * Disable for hosts that only need the browser collaboration services. Defaults to true. */ enableDocumentCollaborationUI?: boolean /** * Whether to enable frontend log. * @default false */ enableFrontendLog?: boolean /** * Load the document named by the unit and type URL parameters on startup. Defaults to true. * Set false when the application calls a collaboration Facade loader itself. */ enableUrlUnitLoader?: boolean}See document loading for plugin and preset examples. This option controls automatic URL loading; explicit Facade loading and collaborative editing remain available.
Conflict recovery
When a client conflict requires local-cache cleanup, the UI shows a persistent processing notification. The client waits for that unit's offline cache to be cleared before offering refresh. If cleanup fails, it shows a retry action and does not reload; a successful retry reloads the page. Treat this as conflict recovery, not a guarantee that unsent local edits were synchronized.
How is this guide?