Changelog

25.0.0 (2021-01-27)

MAJOR BREAKING CHANGES ℹ️

• comments: The Annotations class started operating on Annotation instances. Most of its API was changed to support multiple sources of annotations and active annotations. The API for UI management (register(), switchTo(), etc.) was moved to the new AnnotationsUIs class.
• comments: All three existing annotation UIs (InlineAnnotations, NarrowSidebar, and WideSidebar) are using the new annotations API and started operating on the local collections of annotations instead of the global one. Their API has significantly changed.
• comments: The AnnotationsUI (an interface for annotations UI) has changed. Now it requires the attach( annotations ), detach() and setActiveAnnotation( annotation ) methods and the activeAnnotation observable property to be implemented.

See Changes in the Annotations API for more information.

MINOR BREAKING CHANGES ℹ️

• comments: The Sidebar API has changed and now it operates on the Annotation items from one of annotation UIs. It started adding its newly created items to the collection in the addAnnotation() method.
• comments: The EditorAnnotations class has changed. It started emitting events on actions that might cause changes in the annotations UIs instead of modifying the global collection.

See Changes in the Annotations API for more information.

Features

• comments: Added support for displaying multiple annotation UIs.

Other changes

• comments: Editors will have the processor property initialized with HtmlDataProcessor by default now.

Localization updates

Translations to the Dutch language were updated.

Released packages

Check out the Versioning policy guide for more information.

Changes in the Annotations API

The entire annotations API was redesigned in order to support multiple annotation UIs at the same time. A good example of this is an idea of displaying comments in the sidebar while showing suggestions from track changes in inline balloons when their corresponding suggestions are active. Due to that, some architectural changes were made and quite a lot of breaking changes were introduced with this release. See the migration guide below to check how to adapt to the changes.

const annotations = editor.plugins.get( 'Annotations' );

annotations.register( 'myCustomUI', myCustomUI );
annotations.switchTo( 'myCustomUI' );

// Activate and deactivate the UI.
annotations.attach( 'myCustomUI' );
annotations.detach( 'myCustomUI' );

const annotationsUIs = editor.plugins.get( 'AnnotationsUIs' );

annotationsUIs.register( 'myCustomUI', myCustomUI );
annotationsUIs.switchTo( 'myCustomUI' );

// Activate and deactivate the UI.
annotationsUIs.activate( 'myCustomUI' );
annotationsUIs.deactivate( 'myCustomUI' );

// Activate two different UIs for comments and suggestions.
annotationsUIs.activate( 'wideSidebar', annotation => annotation.type === 'comment' );
annotationsUIs.activate( 'inline', annotation => annotation.type !== 'comment' );
annotationsUIs.deactivateAll();

const annotations = editor.plugins.get( 'Annotations' );

// An annotation view or `null`.
const activeAnnotationView = annotations.activeView;

// A collection of annotation views.
const annotationViewCollection = annotations.items;

// Adding an annotation to the collection.
const target = new Rect( { left: 0, top: 0 } );
annotations.add( innerView, target );

// Removing an annotation based on the inner view.
annotations.remove( innerView );

const annotations = editor.plugins.get( 'Annotations' );

// A set of active annotations.
const activeAnnotations = annotations.activeAnnotations;

// An array of active annotation views.
Array.from( activeAnnotations, annotation => annotation.view );

// A collection of annotations (`Annotation` class items).
const annotationCollection = annotations.collection;

// Adding an annotation to the collection.
annotations.add( new Annotation( {
    view: new AnnotationView( innerView ),
    target: new Rect( { left: 0, top: 0 } ),
    type: 'comment' // The type is used only for the AnnotationsUIs filtering mechanism.
} ) );

// Removing an annotation based on the inner view.
const annotation = annotations.getByInnerView( innerView );
annotations.remove( annotation );

class CustomAnnotationUI {
    attach() {
        const annotations = this.editor.plugins.get( 'Annotations' );

        // The code responsible for displaying annotations
        // based on the global collection of annotations.
    }

    detach() {
        // The code responsible for hiding the UI and detaching
        // listeners from the global annotation collection.
    }
}

class CustomAnnotationUI extends ContextPlugin {
    constructor() {
        this.set( 'activeAnnotation', null );
    }

    setActiveAnnotation( annotation ) {
        // The code responsible for reacting to annotation changes.
        if ( annotation === this.activeAnnotation ) {
            return;
        }

        if ( this.activeAnnotation ) {
            this.activeAnnotation.isActive = false;
        }

        if ( annotation ) {
            annotation.isActive = true;
        }

        this.activeAnnotation = annotation;
    }

    attach( annotations ) {
        // The code responsible for displaying annotations
        // based on the annotation collection passed to this UI.

        // The code responsible for setting an active and non-active annotation based on the annotation focus changes.
        this.listenTo( annotations, 'focus', ( evt, annotation ) => {
            this.setActiveAnnotation( annotation );
        } );

        this.listenTo( annotations, 'blur', () => {
            this.setActiveAnnotation( null );
        } );

        // The code responsible for the integration with editor annotation markers,
        // editor events and the editor selection changes.
        // The requirement of this integration might change in the future.
        // // If the plugin was initialized as an editor plugin, the integration should look like the following:
        const editorAnnotations = editor.plugins.get( 'EditorAnnotations' );

        this.listenTo( editorAnnotations, 'refresh', () => refreshActiveAnnotation.bind( this ) );
        this.listenTo( editorAnnotations, 'blur' ( evt, { isAnnotationTracked } ) => {
            if ( this.activeAnnotation && isAnnotationTracked( this.activeAnnotation ) ) {
                this.setActiveAnnotation( null );
            }
        } );
        this.listenTo( editorAnnotations, 'uiUpdate' () => annotations._refreshPositioning();

        function refreshActiveAnnotation() {
            const selectedAnnotations = editorAnnotations.getOrderedSelectedAnnotations( {
                annotations: this._annotations,
                activeAnnotation: this.activeAnnotation
            } );

            this.setActiveAnnotation( selectedAnnotations[ 0 ] || null );
        }
    }

    detach() {
        // The code responsible for hiding the UI and detaching
        // listeners from the annotation collection, editor annotations and others.
    }
}

24.0.0 (2020-12-09)

Features

• track-changes: Added support for table cell styles while pasting table cells in the track changes mode.
• track-changes Introduced the showSuggestionHighlights option in editor.getData() that changes the suggestion marker conversion and allows styling the suggestions in the output. This allows for highlighting a suggestion after exporting to PDF.
• track-changes Introduced the editorConfig.trackChanges.disableComments option that disallows commenting on suggestions and hides comments UI in the suggestion annotation view.
• track-changes, comments Introduced the .attributes property for comments and suggestions, which can store arbitrary custom data together with other comment/suggestion data.

Bug fixes

• track-changes Redoing table cell paste after undo will restore markers to the original ranges.
• track-changes: Fixed incorrectly created format suggestions when created on a selection containing empty table cells.
• track-changes: Fixed scenarios when a multi-cell suggestion was not highlighted when the selection was placed inside a cell from that suggestion.
• track-changes: Block quote suggestions were set on incorrect cells when adding a block quote to multiple cells.

Other changes

• track-changes: Improved performance of multi-cell selections in track changes mode.

Localization updates

New translations are available for the following languages:

Hungarian, German, Australian English, French, Estonian, Ukrainian, Galician, Italian, Slovak, Serbian, Serbian (Latin), Chinese

Released packages

Check out the Versioning policy guide for more information.

23.1.0 (2020-10-26)

Features

• Added support for pasting a table into a table in track changes mode.

Bug fixes

• Editor should not crash while removing row with horizontally spanned cells in track changes mode.
• Editor should not crash on splitting a cell selected from the outside in track changes mode.

Other changes

• <suggestion-td> element was introduced to mark table cells paste suggestion. It is returned in the editor data, inside table cell elements, to separate new (pasted) and old cell content.

Localization updates

New translations are available for the following languages:

Chinese, French, Italian, Persian

23.0.0 (2020-09-25)

Features

• Introduced support for importing documents and receiving initial data from the Cloud Services server in real-time collaborative editing.

Bug fixes

• Fixed crash that happened when an editor with multiple annotations was destroyed.

Other changes

• Added support for custom headings in track changes mode.

22.0.0 (2020-08-25)

Features

• Introduced the TrackChangesData plugin which returns the editor data with all suggestions accepted or rejected.
• Introduced the sidebar.preventScrollOutOfView configuration option that prevents sidebar items from being moved out of sight (above the sidebar top edge).

Other

• Changed the annotations positioning algorithms.

Localization updates

New translations are available for the following languages:

Dutch, Korean, Russian, Ukrainian

21.0.0 (2020-07-24)

BREAKING CHANGES

• The comments and track changes features now use the recently introduced marker-to-data conversion. This means that the comment and suggestion markers included in the document data returned from the editor will be different than before. The change is backward compatible with regards to old documents you have already saved in your database. These documents will be correctly processed by the editor, however, upon saving, the document data will be returned in the new format.

Features

• Integrated multi-cell table selection with track changes.
• Enabled multi-cell table selection in real-time collaboration.

Bug fixes

• Passing Rect or a callback returning Rect as an annotation target should work now correctly.
• An active suggestion should always be highlighted and visible in the editor content. This concerns cases with multiple suggestions on the same part of the content.
• Fixed incorrect suggestion description for space character deletion.
• Enabling part of the content for restricted editing in track changes mode was crashing the editor.
• Fixed a crash happening when the remove row and remove column suggestions were accepted at the same time.

Other changes

• Switched from marker-to-element conversion to marker-to-data conversion.

Localization updates

New translations are available for the following languages:

Brazilian Portuguese, Chinese, Polish, Turkmen, Uighur

20.0.1 (2020-06-26)

Bug fixes

Fixed an error that occurred under certain conditions when opening a document with comments and real-time collaboration enabled. It could lead to losing all comments added to the document.

This was a regression that occurred only in version 20.0.0. It is strongly recommended to upgrade this package to version 20.0.1.

20.0.0 (2020-06-23)

BREAKING CHANGES

• Comment marker names format has been changed. It was comment:<commentId>, now it is comment:<commentId>:<uniqueId>. This change is related to enabling multi-range comments.

Features

• Introduced support for multi-range comments (multi-cell comments in tables).

Bug fixes

• Fixed a crash happening when an element was inserted after a paragraph insertion suggestion.
• Incorrect comment was activated after creating a second comment on the same element or range.

Notes

At the moment, multi-cell selection and multi-cell comments are supported only without real-time collaboration and when track changes is turned off.

Localization updates

New translations are available for the following languages:

Chinese (China), Slovak.

19.1.0 (2020-05-25)

Features

• Integration for typing around widgets (inserting paragraphs before/after a widget).
• Incorrect comment was activated after creating a second comment on the same element or range.

Localization updates

New translations are available for the following languages:

Australian English, Brazilian Portuguese, Croatian, French, Galician, German, Hungarian, Italian, Japanese, Norwegian, Russian, Serbian, Serbian (Latin), Turkish.

We would like to thank everyone who contributed to these translations!

19.0.1 (2020-04-30)

BREAKING CHANGES

• AnnotationView#active was renamed to #isActive.
• AnnotationView#hasChanges was renamed to #isDirty.
• Due to changes in how comments are loaded for suggestions, comments now need to be loaded before suggestions in the "load and save" integration type (non-adapter integration).
• Users#me is now set to null if Users#defineMe() or Users#useAnonymousUser() was not called.

Features

• Introduced customizable annotation views.
• Introduced translations for Collaboration Features.
• Introduced Users#useAnonymousUser() and config.users.anonymousUserId.

Bug fixes

• User selection marker will now be properly removed when the user switches to a different editor instance or a form field.
• Fixed incorrect accepting and discarding of table row or column suggestions that were in the initial data.

Other changes

• Users#me will no longer set the local user to anonymous by default (if Users#defineMe() was not called).

18.0.0 (2020-03-19)

Features

• Introduced the skipEmpty parameter in CommentsRepository#getCommentThreads().

Bug fixes

• Fixed incorrect suggestion description when styling (e.g. bold) was applied to the whole table.
• Fixed incorrectly created inline formatting suggestion set on a table that had insertion suggestions inside.
• Fixed incorrectly highlighted suggestions for table row or column insertion and deletion.
• Fixed contextual balloon glitches happening when switching from inline annotations to sidebar UI while displaying a comment.
• Fixed the editor crashing during the initial data load in some scenarios involving the track changes adapter.
• Fixed a bug causing new comments to be added with an "Invalid date".
• Comment threads for suggestions will now be correctly returned by CommentsRepository#getCommentThreads().
• Connection errors will no longer permanently crash the editor on Firefox and Safari.
• Introduced a synchronization mechanism to fix comments feature errors happening after reconnecting to the document.
• Fixed the editor crash in the track changes feature happening in scenarios involving reconnection.
• Fixed issues with the editor data, comments and presence list not being properly updated after the editor reconnected to the real-time collaboration server.

Other

• Methods marked as deprecated in release 17.0.0 will be removed in the next release instead of in this release.

17.0.0 (2020-02-20)

BREAKING CHANGES

• New configuration parameter config.collaboration.channelId was introduced in place of config.cloudServices.documentId which got deprecated and will be removed in the next release.
• If you use Context in your application, context plugins should be added to the context configuration instead of the editor configuration. The following plugins were changed to context plugins:
  • Annotations,
  • CommentsRepository,
  • WideSidebar,
  • NarrowSidebar,
  • Sessions,
  • PresenceList,
  • CloudServicesCommentsAdapter. Note that CloudServicesCommentsAdapter needs to be added to the context configuration even if you are passing real-time collaboration plugins in the editor configuration.

Comments

• The following commands were removed:
  • addComment,
  • removeComment,
  • removeCommentThread,
  • updateComment.
• The only editor command used by the comments feature is addCommentThread. It is now the responsibility of CommentsRepository to operate on comments. If your integration extended the removed commands, you should now integrate with the CommentsRepository API.
• The previous API available for the Comments plugin was deprecated and will be removed in the next release. The CommentsRepository API should be used instead.
• The comments adapter methods changed accepted parameters and returned values. See the documentation and align your integration with the changes.
• The comments adapter now requires a new removeCommentThread() method, which should remove the entire comment thread. If you use a custom comments adapter and would like to support comments outside the editor, you will need to provide this method.

Track changes

• Stylesheets for suggestions were cleaned up. If you are using custom styles, please refer to the documentation to see what CSS variables can now be used.

Real-time collaboration

• Sessions#connectedUsers was replaced with Sessions#allConnectedUsers.
• Sessions#sessions was replaced with Sessions#channelSessions.
• Sessions#getUserSessions() now requires a second parameter, channelId.
• Sessions#channelConnectedUsers is now available to get users connected only to a given channel.

Refer to the Sessions API documentation to learn about the new API.

Known issues

• Comments#getCommentThreads() and CommentsRepository#getCommentThreads( { skipNotAttached: true } ) are not returning comment threads added to suggestions. Instead, use CommentsRepository#getCommentThreads( { skipNotAttached: false } ) and filter comment threads by their IDs, comparing them to IDs returned by TrackChanges#getSuggestions().
• NarrowSidebar and WideSidebar need to be added to a context in integrations using multiple editors.

Features

Comments

• Opened the comments feature API. Enabled creating comments on form fields and other DOM elements outside the editor. Please refer to the documentation to learn about all introduced changes.
• Introduced CommentsRepository which is a context plugin that handles comments. It introduces the API to operate on comments and can be used outside or without an editor instance.
• Annotations became a context plugin and can be used outside or without an editor instance.

Track changes

• Added support for the image resize feature.
• Added support for the soft break (Shift+Enter) feature.
• Added support for the horizontal line feature.
• Added support for the page break feature.
• Added support for the restricted editing feature.

Real-time collaboration

• Introduced the config.cloudServices.bundleVersion configuration parameter.

Bug fixes

Track changes

• Fixed the suggestion description for the title element.

Other changes

Track changes

• Cleaned up track changes suggestion marker styles.
• Improved suggestion descriptions for suggestions on/in tables. Now, the description will show the text contained in the suggestion.
• Improved the behavior of the track changes split button. The dropdown will not be disabled if there is at least one enabled item inside it.

Real-time collaboration

• The sessions plugin was changed to a context plugin and now handles connection to multiple channel IDs.
• Presence list became a context plugin and will show all users connected to all editor instances operating in the same context.