@univerjs-pro/collaboration-client-ui

Collaboration UI integration for Web SDK clients.

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

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  /** Show the built-in conflict notification. Defaults to true. */  enableDefaultConflictUI?: boolean}

Conflict recovery

The UI reports the conflict reason and offers reload after the unit's offline cache is cleared. If cleanup fails, it offers retry and does not reload; a successful retry reloads the page. Cache cleanup does not confirm that local edits reached the server.

Set enableDefaultConflictUI: false to hide these notifications and handle CollaborationConflict in your application. Preserve or export its localChanges before refreshing, check cacheCleared, and resolve permission failures separately. See the recovery flow and plugin/preset examples.