CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

RevisionHistoryConfig (revision-history)

@ckeditor/ckeditor5-revision-history/src/revisionhistoryconfig

interface

The configuration of the revision history feature.

ClassicEditor
 	.create( {
			revisionHistory: ... // Revision history feature configuration.
		} )
		.then( ... )
		.catch( ... );

See all editor options.

Filtering

Properties

  • closeRevisionViewerCallback : object

  • editorContainer : HTMLElement

    The DOM element that contains the DOM structure for the editor.

    This element will be hidden when the user opens the revision history.

  • requireRevisionName : boolean | undefined

    Indicates if the names for revisions should be required. Defaults to false.

    If set to true, the user will have to provide a name when saving a new revision. If they try to change the existing revision name to an empty string, the revision name will be reverted to the previous value.

    It will still be possible to save a revision without a name using the feature API and to load the existing nameless revisions.

  • restoreRevisionCallback : object

  • resumeUnsavedRevision : boolean

    Tells the feature whether it should resume updating previously unsaved revision or should save the previously unsaved revision and create a new revision for the changes that will be introduced after the editor is initialized.

    By default, the previously unsaved revision is resumed after the editor is initialized.

    Note that only unsaved revision can be resumed.

    Note that for real-time collaboration, the unsaved revision will be always resumed if the real-time editing session is still active. In other words, even if this is set to false, the unsaved revision will be resumed, if the editing session did not end since the editor was re-initialized. Keep in mind that the editing session is active a long time after the last user leaves the document.

  • showRevisionViewerCallback : object

  • viewerContainer : HTMLElement

    DOM element which contains the DOM structure for revision history viewer.

    This element should be hidden (using CSS) when the editor is initialized. This element will be shown when the user opens the revision history viewer.

  • viewerEditorElement : HTMLElement

    The DOM element for the revision history viewer editor instance.

    This element will be used to initialize the revision history viewer editor instance and will be replaced by it. It should be empty.

  • viewerSidebarContainer : HTMLElement

    The DOM element for the revision history viewer sidebar container.

    This element will be used as a container for the revision history viewer. The sidebar content will be inserted into it.