Commentaires

Informations sur les plugins

Utilisez les commentaires pour discuter des tâches, des commandes et d'autres documents. Un commentaire reste joint à son dossier dans les vues Grid, Kanban, Galerie, Calendrier et Gantt, et les vues de commutation ne créent pas une discussion séparée.

Enregistrer les plugins

Enregistrez les plugins suivants après les plugins Bases core et UI :

Shell
pnpm add @univerjs/thread-comment @univerjs/thread-comment-ui @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 ProductLocale from '@univerjs-pro/bases-thread-comment-ui/locale/fr-FR'import { LocaleType, mergeLocales } from '@univerjs/core'import SharedLocale from '@univerjs/thread-comment-ui/locale/fr-FR'import '@univerjs-pro/bases-thread-comment/facade'import '@univerjs/thread-comment/facade'import '@univerjs/thread-comment-ui/lib/index.css'import '@univerjs-pro/bases-thread-comment-ui/lib/index.css'univerAPI.loadLocales(LocaleType.FR_FR, mergeLocales(SharedLocale, ProductLocale))univer.registerPlugin(UniverBasesThreadCommentPlugin)univer.registerPlugin(UniverBasesThreadCommentUIPlugin)

Fusionner les ressources locales à partir des paquets de commentaires, et configurer l'utilisateur actuel pour l'application. Le plugin UI ajoute des contrôles de commentaires aux enregistrements, et le plugin de données associe des commentaires avec des enregistrements.

Ajouter et lire des commentaires

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() retourne les commentaires qui sont déjà chargés localement. Avec une source de données distante, await record.listCommentsAsync() synchronise les threads qu'il connaît déjà avant de les renvoyer. Les réponses, les mises à jour et la suppression sont décrites dans comment Facade.

Enregistrement et discussions partagées

Les commentaires créés localement sont enregistrés dans le cadre des ressources de base lorsque l'application appelle base.save(). Enregistrez les plugins de commentaires avant de restaurer un instantané.

Les discussions partagées nécessitent également un service de commentaires, une source de données et des permissions. La collaboration de document ne relie pas les commentaires. Configurez d'abord le Modules d'extension de bureau, puis vérifiez la création, la lecture, les permissions et la réouverture avec deux comptes.

Opérations communes

Importez à la fois le commentaire partagé Facade et le produit Facade avant d'appeler ces méthodes. Les helpers du produit créent des ancres stables, et l'API partagée gère les réponses, les mises à jour, la résolution et la suppression. getComments() lit l'état local, tandis que listCommentsAsync() synchronise les threads qu'il connaît déjà à travers la source de données configurée; il ne découvre pas tous les thread sur le serveur.

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.',  })}

Discussions partagées

Pour activer les discussions partagées, intégrez le Service de commentaires et le Point d'extrémité par le Server SDK, puis enregistrez UniverThreadCommentDataSourcePlugin depuis @univerjs-pro/thread-comment-datasource après la collaboration et la licence sont configurées. La source de données groupée appelle /universer-api/comment/unit/{unitId}/... et /universer-api/user/list. L'application doit donc exposer ces routes.

Que pensez-vous de ce guide ?

© 2026 DreamNum Co., Ltd.