演示跟随

插件信息

注意事项

演示跟随功能需要 Univer 服务端支持,请确保你已经正确安装并配置了 Univer 服务端。具体请参考:许可证

演示跟随(Live Share)功能允许用户在多人协作时,将自己的视图操作(如滚动、选区变化)实时同步给其他跟随的用户,或者跟随其他用户的视角。这在会议演示、教学讲解等场景中非常有用。

插件模式

安装

Shell
pnpm add @univerjs-pro/live-share

使用

TypeScript
import { UniverLiveSharePlugin } from '@univerjs-pro/live-share'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import '@univerjs-pro/live-share/lib/index.css'import '@univerjs-pro/live-share/facade'const univer = new Univer({  // ...})univer.registerPlugin(UniverLiveSharePlugin)

如果你拥有 Univer 的商业许可证,请参考在客户端使用许可证进行配置。

Facade API

演示跟随功能在 Facade API 中扩展了相关接口,你可以通过 univerAPI 直接调用。

引入

插件模式提示

仅插件模式需要手动引入 Facade 包。预设模式已内置对应的 Facade 包,无需额外导入。

TypeScript
import '@univerjs-pro/live-share/facade'

状态枚举

TypeScript
export enum LiveShareStatus {  IDLE = 'idle',  FOLLOWING = 'following',  PRESENTING = 'presenting',}

使用示例

TypeScript
// 获取当前状态const status = univerAPI.getLiveShareStatus()if (status === LiveShareStatus.IDLE) {  // 如果当前空闲,开始演示  univerAPI.startPresenting()} else if (status === LiveShareStatus.PRESENTING) {  // 如果正在演示,停止演示  univerAPI.stopPresenting()}// 开始跟随univerAPI.startFollowing()// 停止跟随univerAPI.stopFollowing()

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.