@ckeditor/ckeditor5-highlight

What is @ckeditor/ckeditor5-highlight?

@ckeditor/ckeditor5-highlight is a plugin for CKEditor 5 that allows users to highlight text with different colors. It is useful for emphasizing parts of the text, making it easier to spot important information, or for collaborative editing where different colors can represent different users' contributions.

What are @ckeditor/ckeditor5-highlight's main functionalities?

Highlight Text

This feature allows users to highlight text within the editor. The code sample demonstrates how to initialize CKEditor with the Highlight plugin and add the highlight button to the toolbar.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Highlight ], toolbar: [ 'highlight' ] })

Custom Highlight Options

This feature allows users to define custom highlight options. The code sample shows how to configure the editor with custom highlight colors and options.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Highlight ], toolbar: [ 'highlight' ], highlight: { options: [ { model: 'yellowMarker', class: 'marker-yellow', title: 'Yellow marker', color: 'var(--ck-highlight-marker-yellow)', type: 'marker' }, { model: 'greenMarker', class: 'marker-green', title: 'Green marker', color: 'var(--ck-highlight-marker-green)', type: 'marker' } ] } })

Other packages similar to @ckeditor/ckeditor5-highlight

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers a similar text highlighting feature through its built-in formats and can be extended with custom formats. Compared to @ckeditor/ckeditor5-highlight, Quill provides a more flexible and extensible architecture but may require more configuration for advanced use cases.

tinymce

TinyMCE is another popular WYSIWYG editor that includes text highlighting capabilities. It offers a wide range of plugins and customization options. TinyMCE is comparable to @ckeditor/ckeditor5-highlight in terms of functionality but provides a different API and configuration approach.

README

CKEditor 5 highlight feature

This package implements text highlight support for CKEditor 5.

Installation

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

npm install ckeditor5

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 highlight feature guide.

Documentation

See the @ckeditor/ckeditor5-highlight package page in CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.