CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

TrackChangesConfig (track-changes)

@ckeditor/ckeditor5-track-changes/src/trackchangesconfig

interface

The configuration of the track changes feature.

Example:

ClassicEditor
	.create( {
		// Track changes feature configuration.
		trackChanges: {
		// Do not allow users to comment suggestions (default is `false`).
		disableComments: true,
		// Do not track styling and formatting changes (default is `default`).
		trackFormatChanges: 'never',
		// Merges suggestion changes inside a block. (default is `true`).
		mergeNestedSuggestions: true
		}
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • SuggestionThreadView : default | undefined

    A view class to be used to create suggestion thread views.

    SuggestionThreadView is used by default when this property is not set.

  • SuggestionView : default | undefined

    A view class to be used to create the suggestion view.

    SuggestionView is used by default when this property is not set.

  • disableComments : boolean | undefined

    A property that specifies if the comments for suggestions are enabled or disabled. When the option is set to true, the comment thread UI for suggestions will be hidden and commenting suggestions will be disabled.

    Suggestion thread views will be marked with the additional ck-suggestion--disabled-comments class when the suggestion comments are disabled.

    Defaults to false

  • mergeNestedSuggestions : boolean | undefined

    Specifies whether suggestions on an object (e.g. image, table) should be automatically merged with suggestions inside the object (e.g. image caption, table cell).

    For example, when set to true, creating a table and writing some text inside the table will result in one suggestion. When set to false, it will be two separate suggestions, one for the inserted table and one for the inserted text.

    Keep in mind that only suggestions from the same author and of the same type are merged this way.

    Defaults to true

  • preview : TrackChangesPreviewConfig | undefined

    Configuration of the track changes preview feature.

  • trackFormatChanges : 'default' | 'always' | 'never' | undefined

    A property that specifies whether formatting changes should be tracked.

    Formatting changes are all changes other than insertions and deletions, including: styling, structure, widgets properties, etc.

    By default, formatting changes are tracked. However, if you make a formatting change inside your own insertion suggestion, it is immediately applied, without creating a suggestion.

    Possible values are:

    • 'default' - format changes are tracked, but when made inside your own insertion suggestion, they will be immediately applied.
    • 'always' - format changes will always be tracked, even inside your own insertion suggestion.
    • 'never' - format changes will never be tracked (suggestions for such changes will not be created).

    Defaults to 'default'