Web SDK

Comentarios

Información de complementos

Comenta tareas, pedidos y otros registros. Los comentarios permanecen vinculados al registro en las vistas Cuadrícula, Kanban, Galería, Calendario y Gantt; cambiar de vista no crea una conversación independiente.

Registrar los plugins

Añádelos después de los plugins principales y de interfaz de Bases:

Shell
pnpm add @univerjs-pro/bases-thread-comment @univerjs-pro/bases-thread-comment-ui
TypeScript
import { UniverBasesThreadCommentPlugin } from '@univerjs-pro/bases-thread-comment'import { UniverBasesThreadCommentUIPlugin } from '@univerjs-pro/bases-thread-comment-ui'import '@univerjs-pro/bases-thread-comment/facade'import '@univerjs/thread-comment/facade'import '@univerjs-pro/bases-thread-comment-ui/lib/index.css'univer.registerPlugin(UniverBasesThreadCommentPlugin)univer.registerPlugin(UniverBasesThreadCommentUIPlugin)

Combina los recursos de idioma de los paquetes de comentarios y configura el usuario actual de la aplicación. El plugin UI añade los controles de comentarios de los registros; el plugin de datos vincula los comentarios a los registros.

Añadir y leer comentarios

TypeScript
const record = univerAPI.getActiveBase()?.getTables()[0]?.getRecords()[0]if (!record) throw new Error('Create a record first')await record.createCommentAsync('Please confirm the delivery date.')const comments = record.getComments()console.log(comments.map(({ root }) => root.id))

getComments() lee los comentarios cargados localmente. Con una fuente de datos remota, await record.listCommentsAsync() sincroniza los hilos conocidos antes de devolverlos. Consulta la Facade de comentarios para responder, actualizar y eliminar.

Guardado y conversaciones compartidas

Los comentarios locales se pueden guardar como recursos de Base mediante base.save(). Registra los plugins de comentarios antes de restaurar una instantánea.

Las conversaciones compartidas también necesitan un servicio de comentarios, una fuente de datos y permisos. La colaboración documental por sí sola no conecta los comentarios. Sigue los módulos de extensión de Office y prueba la creación, lectura, permisos y reapertura con dos cuentas.

Operaciones comunes

Importa la Facade común y la del producto. Los métodos del producto crean anclas estables; la API común gestiona respuestas, cambios, resolución y eliminación. getComments() lee el estado local. listCommentsAsync() sincroniza los hilos ya conocidos mediante la fuente configurada; no descubre todos los hilos del servidor.

TypeScript
import '@univerjs/thread-comment/facade'const [thread] = univerAPI.getComments({ resolved: false })if (thread) {  await univerAPI.replyCommentAsync({    unitId: thread.unitId,    subUnitId: thread.subUnitId,    threadId: thread.threadId,    content: 'Reviewed.',  })}

Conversaciones compartidas

Integra Comment Service y Endpoint con Server SDK y registra UniverThreadCommentDataSourcePlugin de @univerjs-pro/thread-comment-datasource tras configurar la colaboración y la licencia. La fuente incluida usa /universer-api/comment/unit/{unitId}/... y /universer-api/user/list: expón esas rutas en la aplicación. El servidor debe autorizar la lectura y escritura de comentarios de forma independiente de la edición del documento.

¿Cómo es esta guía?

© 2026 DreamNum Co., Ltd.