Modes
1. Freestyle mode
Whether Freestyle Mode is enabled.
Default: true
<VeltComments/> {/* Freestyle mode is enabled by default when you use VeltComments}
2. Inbox mode
Whether Inbox Mode is enabled.
Default: false
<VeltComments inboxMode={true} />
API Method:
const commentElement = client.getCommentElement();
commentElement.enableInboxMode();
commentElement.disableInboxMode();
3. Popover mode
Whether Popover Mode is enabled.
Default: false
<VeltComments popoverMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enablePopoverMode();
commentElement.disablePopoverMode();
4. Stream mode
Whether Stream Mode is enabled.
Default: false
<VeltComments streamMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enableStreamMode();
commentElement.disableStreamMode();
5. Text mode
Whether Text Mode is enabled.
Default: true
<VeltComments textMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enableTextComments();
commentElement.disableTextComments();
6. Persistent comment mode
Whether Persistent comment mode is enabled.
Default: false
When Persistent comment mode is enabled, you can continue leave additional comments after finishing a comment.
When it is disabled, you will need to reclick the Comment Tool every time when you want to make a comment.
<VeltComments persistentCommentMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enablePersistentCommentMode();
commentElement.disablePersistentCommentMode();
7. Inline Comment Mode
Whether In-line comment mode is enabled.
When In-line comment mode is enabled, comments will appear under the text they are associated with in the DOM, instead of as a pop up window.
Default: false
<VeltComments inlineCommentMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enableInlineCommentMode();
commentElement.disableInlineCommentMode();
Was this page helpful?