API Reference

@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  /**   * Whether to enable frontend log.   * @default false   */  enableFrontendLog?: boolean}

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?

© 2026 DreamNum Co., Ltd.