API Reference

@univerjs-pro/shape-thread-comment

Facade methods for comments anchored to generic Shapes (FShape), with host-independent helpers for floating-element comment integrations.

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

The Facade entry adds createCommentAsync(), getComments(), and listCommentsAsync() to FShape. Configure the host's Shape plugins first. The plugin supplies shared thread-comment dependencies; configure comment UI and storage separately.

For images and charts, register the matching product integration and import its /facade entry:

Entry Points

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

How is this guide?

© 2026 DreamNum Co., Ltd.