Using TinyMCE Comments

Overview

This guide provides instructions for using the comments plugin, including how to:

To try these steps, use the Comments interactive example.

The editor must contain content before a comment can be added.

Add a comment

  1. Select the content to comment on.

  2. Start a new comment in one of the following ways:

    1. Choose Insert → Add comment.

    2. Click the Add comment Add comment toolbar button.

    3. Press Ctrl+Alt+M (Windows/Linux) or Cmd+Option+M (macOS).

  3. The Comments sidebar opens with an empty comment box. The placeholder text is "Add comment…​", or "Comment or mention with @" when mentions are enabled.

  4. Type the comment. To add a new line, press Shift+Enter.

  5. Click Save or press Enter to save the comment, or click Cancel to discard it.

Result: The selected content is highlighted in the editor, and the comment is displayed in the Comments sidebar.

Replying to comments

  1. Select the conversation in the editor or in the Comments sidebar.

  2. In the conversation, click Add comment…​.

  3. Type the reply.

  4. Click Save or press Enter to save the reply, or click Cancel to discard it.

Edit a comment

  1. Click the ellipsis (ellipsis - 3 horizontal dots) icon on the comment to open the menu.

  2. Select Edit.

  3. Change the comment, then click Save, or click Cancel to discard the changes.

Delete a comment

This option is available for replies only. To delete the first comment in a conversation, delete the conversation.

  1. Click the ellipsis (ellipsis - 3 horizontal dots) icon on the comment to open the menu.

  2. Select Delete.

  3. In the Delete Comment dialog, click Delete to delete the comment, or Cancel to keep it.

Delete a comment thread (conversation)

This option is available on the first comment in a conversation only.

  1. Click the ellipsis (ellipsis - 3 horizontal dots) icon on the first comment to open the menu.

  2. Select Delete conversation.

  3. The Delete Conversation dialog states how many comments will be deleted. Click Delete to delete the conversation, or Cancel to keep it.

Result: The conversation and all of its comments are deleted from the document.

Resolve a comment thread (conversation)

This option is available on the first comment in a conversation only, and requires the tinycomments_resolve option in callback mode or the tinycomments_can_resolve option in embedded mode.

  1. Click the ellipsis (ellipsis - 3 horizontal dots) icon on the first comment to open the menu.

  2. Select Resolve conversation.

  3. The Resolve Conversation dialog states how many comments will be resolved. Click Resolve to resolve the conversation, or Cancel to keep it open.

Result: The conversation is removed from the Comments sidebar, and its highlight is removed from the content. In embedded mode, the conversation is removed from the content. In callback mode, the tinycomments_resolve callback determines how the resolved conversation is stored.

Show or view a comment

  1. Place the cursor in highlighted content in the editor.

  2. Choose View → Show comments, or click the Show comments Show comments toolbar button.

Result: The Comments sidebar opens and displays the conversation for the highlighted content.

Delete all comment threads

  1. Choose File → Delete all conversations.

  2. A dialog asks "Delete all conversations in the content? This cannot be undone." Click Yes to delete all conversations in the document, or No to cancel.