@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

45.1.0 (May 14, 2025)

We are happy to announce the release of CKEditor 5 v45.1.0.

Release highlights

Typing Improvements

The typing behavior has been improved for plain text typing. This adjustment allows the web browser to handle text insertion before the editor processes it, enhancing typing reliability across various scenarios, especially on Safari and iOS devices. Issues related to track changes, autocorrect, automatic text replacement, and other input methods have been addressed.

Track Changes Enhancements

A new method to start a "tracking session" has been introduced, preventing automatic merging of adjacent suggestions. This allows for more precise control over individual changes, catering to workflows that require selective acceptance of edits.

Miscellaneous improvements

• Sticky toolbars and balloons are now better aligned with the visual viewport on iOS and Safari, ensuring correct positioning when zooming.
• The fullscreen plugin has been improved to maintain scroll position when exiting fullscreen, avoiding unexpected jumps on smooth-scrolling pages. Layout consistency has been refined by adjusting margins and editable width. Errors related to the Content minimap plugin in fullscreen mode have also been resolved.
• Introduced a fix which ensures that the data-author-id and data-suggestion attributes are preserved in non-block suggestions when retrieving data with showSuggestionHighlights: true.
• We improved the algorithm for images detection in the Paste from Office feature, in scenarios of mixed local and online images from Microsoft Word. Paste no longer causes some images not to appear.