@ckeditor/ckeditor5-track-changes/README.md

CKEditor 5 track changes plugin.

# CKEditor 5 Track changes feature

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-track-changes.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-track-changes)

[CKEditor 5 Track changes feature](https://ckeditor.com/collaboration/track-changes/) is a collaboration feature that makes it possible to track every change done by the user, mark the changes in the WYSIWYG editor content and show as suggestions.

This is a premium feature. Sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free), or see: [https://ckeditor.com/pricing](https://ckeditor.com/pricing) for more information.

## About this feature

The user is able to track all basic actions available in the rich text editor, including:
* Typing, deleting, splitting, merging blocks,
* Inline formatting (bold, italic, etc.),
* Inserting images,
* Block formatting (lists, headers, block quotes, etc.),
* Table manipulations (inserting or removing rows and columns, splitting or merging cells, etc.).

They can also approve or discard individual changes, all selected changes or all changes together.

CKEditor 5 will automatically merge adjacent suggestions done by the same user and ensure that the users are not able to overwrite suggestions created by others as long as they have no full editing permissions.

It is also possible to [comment](https://ckeditor.com/collaboration/comments/) on suggested changes.

Suggestions can be [displayed](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/comments/comments-display-mode.html) in three modes:

- Wide sidebar:

![A screenshot of CKEditor 5 Track changes feature with suggestions displayed in the wide sidebar](https://c.cksource.com/a/1/img/npm/ckeditor5-track-changes.png)

- Narrow sidebar:

![A screenshot of CKEditor 5 Track changes feature with suggestions displayed in the narrow sidebar](https://c.cksource.com/a/1/img/npm/ckeditor5-track-changes-narrow.png)

- Inline balloons:

![A screenshot of CKEditor 5 Track changes feature with suggestions displayed inline](https://c.cksource.com/a/1/img/npm/ckeditor5-track-changes-inline.png)

The track changes feature also works with the [real-time collaborative editing feature](https://ckeditor.com/collaboration/real-time-collaborative-editing/).

## Installation

This plugin is part of the `ckeditor5-premium-features` package. Install the whole package to use it.

```bash
npm install ckeditor5-premium-features
```

## Create free account

If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free).

## Demo

Check out the [demo in the Track changes](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html#demo) feature guide.

## Documentation

For more information about the track changes feature see the [CKEditor 5 Track changes feature documentation](https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html).

Also, make sure you visit the [CKEditor 5 changelog](https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md) whenever a new version of the package is released.

## Browser compatibility

CKEditor 5 Track changes feature works in all major modern browsers: Chrome, Firefox, Safari, and Edge. They are also compatible with mobile environments: Android and iOS. Refer to the CKEditor 5 [Browser compatibility](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/support/browser-compatibility.html) article for more details.

## Getting support

CKEditor 5 Track changes feature comes with outstanding support from a dedicated team of customer care specialists, QA engineers and CKEditor 5 developers. The team will gladly assist you in all aspects from setting up your account to integrating CKEditor 5 Track changes features with your application.

As a licensed CKEditor 5 Track changes feature user you can report bugs and request features directly through the CKEditor Ecosystem customer dashboard.

## License

**CKEditor&nbsp;5 Track changes feature** (https://ckeditor.com/collaboration/track-changes/)<br>
Copyright (c) 2003–2025, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.

CKEditor&nbsp;5 Track changes feature is licensed under a commercial license and is protected by copyright law. For more information, see: [https://ckeditor.com/pricing](https://ckeditor.com/pricing).

### Trademarks

**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.