Review workflow

A rich text editor with track changes.

Suggest edits, comment on a passage, and compare versions, in the editor your users already write in.

Details

Reviewers suggest edits instead of overwriting text. Each insertion and deletion stays visible until someone accepts or rejects it. Threaded comments and revision history are part of the same editor, and all three are included in every license.

What reviewers get

Suggest, discuss, compare.

Suggesting modeInsertions are underlined in the author’s colour. Deletions are struck through and stay until accepted.
Threaded commentsA comment anchors to selected text and opens a thread with replies and resolve.
Revision historySave named versions, compare two of them line by line, and restore one.

Turn on track changes

Two settings enable suggesting mode and comments. currentUser names the author of each change. reviewCanDecide lets your application decide who may accept or reject: a denied decision leaves the suggestion pending, and an accepted or rejected one records who decided.

var editor = new RichTextEditor("#editor", {
    trackChangesEnabled: true,
    commentsEnabled: true,
    currentUser: { id: "maya", name: "Maya Patel", color: "#9333ea" },
    // Your application decides who may accept or reject a suggestion.
    reviewCanDecide: (entry, action, user) => user.role === "editor"
});

Comments from your own code

Writers add comments from the toolbar. Your code can also create, reply to, resolve and list threads, for example to save them with the document.

editor.comments.add(range, text);
editor.comments.reply(threadId, text);
editor.comments.resolve(threadId);
editor.comments.list();

Versions you can compare

Revision history keeps snapshots in the browser by default, or posts them to an endpoint on your server. Use a same-origin endpoint with your existing session and CSRF protection.

editor.revisionHistory.snapshot("Sent to legal");
editor.revisionHistory.list();
editor.revisionHistory.diff(idA, idB);   // { lines, oldText, newText }
editor.revisionHistory.restore(id);

Before you choose it for review

  • Review and live co-editing are separate features. Track changes, comments and revision history are settings on the editor. Typing in the same document at the same time uses the Yjs collaboration engine, and you run the Yjs provider. See the collaborative editor page.
  • Your server stores the result. Save the document and its review data through your own endpoints, and enforce who may review on the server as well as in reviewCanDecide.
  • No add-on to buy: track changes, comments and revision history are in every license, from $129 one-time. For pages, Word files and PDF, see the document editor page. See pricing and how this compares with TinyMCE and CKEditor.