Comments

Release 3.3.0 and above.

The comments feature allows you to leave opinions, explanations, and review requests within a document.

When you select specific text or sentences in the document and add a comment, a comment indicator is created at that location. You can manage the comment content and replies in the right-side panel.

Created comments also support the following editing features:

  • Edit: You can change the content of an existing comment.
  • Complete: Comments that have been reviewed can be marked as complete and organized in the list.
  • Reopen: Completed comments can be reopened when needed again.
  • Highlighting: The location where a comment is anchored in the document is highlighted for quick identification.

This feature is very useful for sharing and organizing opinions during the document review process.

// synapeditor.config.js
{
  'editor.toolbar': [
    // ...
    'showMemo' // Adds the comment button to the toolbar
    // ...
  ]
}

Insert comment

Comment Edit

Edit comment

Comment Complete / Reopen

Complete/reopen comment

Change Comment User Info

You can set user info using the setUserInfo API on the editor.

See more: setUserInfo

User info setting