API Reference

@univerjs-pro/shape-thread-comment

Facade methods for comments anchored to images, charts, and Shapes in Sheets, Docs, Slides, and Boards.

TypeScript
import { UniverShapeThreadCommentPlugin } from '@univerjs-pro/shape-thread-comment'import '@univerjs-pro/shape-thread-comment/facade'univer.registerPlugin(UniverShapeThreadCommentPlugin)const image = univerAPI.getActiveWorkbook()?.getActiveSheet()?.getImages()[0]await image?.createCommentAsync('Replace this image.', { id: 'review-image-1' })

The Facade entry adds createCommentAsync(), getComments(), and listCommentsAsync() to supported element Facades.

Entry Points

  • Facade: @univerjs-pro/shape-thread-comment/facade

How is this guide?

© 2026 DreamNum Co., Ltd.