@ckeditor/ckeditor5-list

What is @ckeditor/ckeditor5-list?

@ckeditor/ckeditor5-list is a plugin for CKEditor 5 that provides advanced list editing capabilities. It allows users to create and manage ordered and unordered lists, as well as nested lists, with ease.

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

Ordered List

This feature allows users to create ordered (numbered) lists in the editor. The code sample demonstrates how to initialize CKEditor with the List plugin and add the 'numberedList' button to the toolbar.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ List ], toolbar: [ 'numberedList' ] });

Unordered List

This feature enables users to create unordered (bulleted) lists. The code sample shows how to set up CKEditor with the List plugin and include the 'bulletedList' button in the toolbar.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ List ], toolbar: [ 'bulletedList' ] });

Nested Lists

This feature allows users to create nested lists, both ordered and unordered. The code sample demonstrates initializing CKEditor with the List plugin and adding both 'numberedList' and 'bulletedList' buttons to the toolbar.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ List ], toolbar: [ 'numberedList', 'bulletedList' ] });

Other packages similar to @ckeditor/ckeditor5-list

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It provides basic list functionalities similar to @ckeditor/ckeditor5-list, but it may require additional configuration or plugins for more advanced list features.

tinymce

TinyMCE is a popular rich text editor that offers comprehensive list editing capabilities, including ordered, unordered, and nested lists. It is comparable to @ckeditor/ckeditor5-list in terms of functionality but has a different API and configuration approach.

draft-js

Draft.js is a framework for building rich text editors in React. It supports list functionalities through its built-in features and additional plugins. While it provides similar capabilities to @ckeditor/ckeditor5-list, it requires more setup and customization.

README

CKEditor 5 list feature

This package implements bulleted, numbered, and to-do list features 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 demos for ordered and unordered lists as well as to-do list in the CKEditor 5 documentation.

Documentation

See the @ckeditor/ckeditor5-list 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.

Changelog

44.1.0 (December 16, 2024)

We are pleased to announce the latest CKEditor 5 release, focusing on performance enhancements and key bug fixes to improve your editing and collaboration experience.

Release Highlights

⚡ Performance enhancements: Part 3

This release introduces another set of performance related improvements, focused on faster editor initialization for huge documents. The initialization time was lowered by further 15% to 45%, depending on the tested sample.

The combined improvements introduced in recent releases amount to around 65%-80% lower loading time in total, which means the editor will load 3-5x faster. As the gain is not linear, bigger documents see even better improvement (more than 10x faster).

Moreover, all these improvements positively impact document save time (editor.getData()), which should help with autosave issues, among others.

We still actively work in this area, so you may expect even more editor load and save efficiency improvements in the upcoming releases.

🔨 Bug Fixes and improvements

• Comments enhancements:
  • Data export options: We introduced the showCommentHighlights option in editor.getData(), that changes the comment marker conversion, allowing for styling comments in the output. Perfect for showing what was commented in Export to PDF, for example.
  • Inline mode improvements: We addressed a problem where comment annotations in inline mode did not close properly when clicking elsewhere in the content.
  • Thread management: We resolved an issue where creating a new thread was not interrupted when the corresponding marker was removed from the content, ensuring better stability during collaborative editing.
• Revision History update:
  • Restore functionality: We disabled the ability to restore the current (edited, not saved) revision, as it represents current content, so there is nothing to restore. At the same time, using it led to some non-obvious behaviors.
• Image handling: We resolved an issue where images in the uploading state could be deleted when dragged and dropped within the editor. Keep dragging, even when it is not there 🙈.

🎄 Happy holidays!

As the holiday season approaches, we extend our warmest wishes to our community and users. Thank you for your continued support, and we look forward to bringing you further enhancements and exciting features in the coming year.