Skip to main content
For type definitions, see VeltCommentComposerProps.

​
context

Pass custom context data to comments created via the Comment Composer. The provided context object will be added to the comment annotation, allowing you to associate additional metadata with comments. 
<VeltCommentComposer context={{ "key": "value" }} />

​
documentId

Set a specific document ID for comments created via the Comment Composer. This allows you to associate comments with a particular document. 
<VeltCommentComposer documentId='YOUR_DOCUMENT_ID' />

​
folderId

Set a specific folder ID for comments created via the Comment Composer. This allows you to associate comments with a particular folder. 
<VeltCommentComposer folderId='YOUR_FOLDER_ID' />

​
locationId

Set a specific location ID for comments created via the Comment Composer. This allows you to associate comments with a particular location. 
<VeltCommentComposer locationId='YOUR_LOCATION_ID' />

​
placeholder

Customize the input placeholder text in the comment composer. Overrides default placeholders. 
<VeltCommentComposer placeholder="Share your thoughts..." />

​
targetComposerElementId

Set a unique identifier for the composer to enable programmatic submission via the submitComment() method. 
<VeltCommentComposer targetComposerElementId="composer-1" />

​
clearComposer

Reset composer state including text, attachments, recordings, tagged users, assignments, and custom lists. Refer to clearComposer() for more details.

​
submitComment

Programmatically submit a comment from a composer. Refer to submitComment() for more details.

​
getComposerData

Get the current state of the composer including text, attachments, recordings, tagged users, assignments, and custom lists. Refer to getComposerData() for more details.

​
readOnly

Disable comment input at the component level. When set to true, the composer will be in read-only mode. The component-level readOnly prop takes precedence over the global read-only setting when explicitly set. 
<VeltCommentComposer readOnly={true} />