JSPM

@ckeditor/ckeditor5-track-changes

0.0.0-nightly-20241206.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 80046
  • Score
    100M100P100Q177850F
  • License SEE LICENSE IN LICENSE.md

CKEditor 5 track changes plugin.

Package Exports

  • @ckeditor/ckeditor5-track-changes
  • @ckeditor/ckeditor5-track-changes/dist/index.js
  • @ckeditor/ckeditor5-track-changes/src/index.js
  • @ckeditor/ckeditor5-track-changes/src/suggestion
  • @ckeditor/ckeditor5-track-changes/src/suggestion.js
  • @ckeditor/ckeditor5-track-changes/src/trackchanges
  • @ckeditor/ckeditor5-track-changes/src/trackchanges.js
  • @ckeditor/ckeditor5-track-changes/src/trackchangesediting
  • @ckeditor/ckeditor5-track-changes/src/trackchangesediting.js
  • @ckeditor/ckeditor5-track-changes/theme/icons/track-changes.svg

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ckeditor/ckeditor5-track-changes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CKEditor 5 Track changes feature

npm version

CKEditor 5 Track changes feature 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, or see: 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 on suggested changes.

Suggestions can be displayed in three modes:

  • Wide sidebar:

A screenshot of CKEditor 5 Track changes feature with suggestions displayed in the wide sidebar

  • Narrow sidebar:

A screenshot of CKEditor 5 Track changes feature with suggestions displayed in the narrow sidebar

  • Inline balloons:

A screenshot of CKEditor 5 Track changes feature with suggestions displayed inline

The track changes feature also works with the real-time collaborative editing feature.

Installation

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

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.

Demo

Check out the demo in the Track changes feature guide.

Documentation

For more information about the track changes feature see the CKEditor 5 Track changes feature documentation.

Also, make sure you visit the CKEditor 5 changelog 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 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 5 Track changes feature (https://ckeditor.com/collaboration/track-changes/)
Copyright (c) 2003–2024, CKSource Holding sp. z o.o. All rights reserved.

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

Trademarks

CKEditor is a trademark of CKSource Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.