Options

Default configuration

const defaultOptions = {
  revision: {
    enabled: false,
    defaultEnabled: false,
    allowAcceptReject: true,
    defaultMarkupMode: 'final-markup',
    defaultReviewers: ['all'],
  },
}

Options reference

revision.enabled

Description: Enables Track Changes (registers the revision extension). When disabled, revision UI and revision APIs are not available.

Type: Boolean

Default: false

revision.defaultEnabled

Description: Whether tracking is enabled by default on initialization. When enabled, typing/deleting automatically generates revision marks.

Note: defaultEnabled only takes effect when revision.enabled = true. If the revision extension is not enabled, defaultEnabled = true will not start tracking.

What marks are generated

• insertion: newly added content. Usually shown with green underline/highlight; appears as normal text in final, and is hidden in original.
• deletion: removed content kept as a reviewable change. Usually shown with red strike-through/highlight; hidden in final, and shown as normal text in original.
• Node changes (some node types): inserting/removing trackable nodes writes attributes like data-revision-type, data-revision-id, data-revision-user-*, and data-revision-date and shows them as change records in the review panel.

Markup modes only change rendering; they do not remove marks. To permanently finalize, accept/reject changes.

Type: Boolean

Default: false

revision.allowAcceptReject

Description: Whether users can accept/reject changes. When disabled, you can still track and view changes, but cannot finalize them.

Type: Boolean

Default: true

revision.defaultMarkupMode

Description: Default markup mode. Allowed values:

• final-markup
• final
• original-markup
• original

Type: String

Default: final-markup

revision.defaultReviewers

Description: Default author filter for the review stream.

• ['all']: no filter (default)
• ['userId1', 'userId2']: filter by user id
• ['Alice', 'Bob']: filter by user name

Type: String[]

Default: ['all']