1. Freestyle mode
For a complete setup guide for Freestyle mode,
read here.
Whether Freestyle Mode is enabled.
Default: true
2. Inbox mode
For a complete setup guide for Inbox mode,
read here.
Whether Inbox Mode is enabled.
Default: false
<VeltComments inboxMode={true} />
API Method:
const commentElement = client.getCommentElement();
commentElement.enableInboxMode();
commentElement.disableInboxMode();
3. Popover mode
For a complete setup guide for Popover mode,
read here.
Whether Popover Mode is enabled.
Default: false
<VeltComments popoverMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enablePopoverMode();
commentElement.disablePopoverMode();
4. Stream mode
For a complete setup guide for Stream mode,
read here.
Whether Stream Mode is enabled.
Default: false
<VeltComments streamMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enableStreamMode();
commentElement.disableStreamMode();
5. Text mode
For a complete setup guide for Text mode,
read here.
Whether Text Mode is enabled.
Default: true
<VeltComments textMode={true}/>
API Method:
const commentElement = client.getCommentElement();
commentElement.enableTextComments();
commentElement.disableTextComments();
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();
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();
- By default comments are single threaded.
- You can make it multithreaded by setting
multiThread
prop to true
.
- If you had previously used a wireframe for the comment dialog, you will need to add the multithread wireframe.
- Default:
false
<VeltComments multiThread={true} />
- By default inline comment section is multithreaded.
- You can make it single threaded by setting
multiThread
prop to false
.
- Default:
true
<VeltInlineCommentsSection multiThread={false} />