@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.2.0 (February 12, 2025)

We are happy to announce the release of CKEditor 5 v44.2.0.

Release Highlights

🖥️ Enhanced Source Code Editing (⭐)

Introducing new premium feature: Enhanced Source Code Editing. It displays the source code in a dialog and is compatible with all editor types. It offers syntax highlighting, code completion, code folding, and other advanced functionalities. Additionally, it supports both HTML and Markdown formats.

📤 Uploadcare and image optimizer (⭐)

We have integrated the Uploadcare image manager service, enabling you to upload and edit images to their cloud environment. You can upload files from various sources, including local devices, social media, or online drives ensuring rapid uploads. The integration takes care of efficient media delivery with responsive images mechanism, making sure your users will save bandwidth and have faster website loading. You can also optimize images with the built-in image editor which offers a range of features, such as cropping, rotating, flipping, photo filters and more. All this directly from the editor, try it out!

🖼️ Image Merge Fields (⭐)

Image merge fields are a new type of merge fields, dedicated for image placeholders. They maintain all standard image interactions, like styling, resizing or captions (in which you can use merge fields too!) At the same time, they keep all merge fields functionalities, like data previews or document export integration. In the document data, image merge fields are represented like other images, however their src attribute is set to a respective merge field, for example, src="{{CompanyLogo}}", making them easy to post-process!

📝 Track Changes Preview (⭐)

We have added the preview mode that displays a document with all suggestions accepted. Accessible from the track changes dropdown, this modal preview helps check the final content without extensive markers.

😀 Emoji support

They are here! 🎉 🥳 🎊 Insert emojis effortlessly in the editor by typing : or through a user-friendly emoji picker. This feature enhances the richness of your content by allowing quick access to a wide range of emojis.

⚡ Performance improvements: Part 4

Here comes the final batch of the planned performance improvements in the editor loading speed area, that we worked on through a couple of past releases.

• A new caching mechanism in Mapper now handles model-to-view mappings, substantially improving performance for loading and saving data.
• Images with specified height and width automatically use [loading="lazy"] in the editing area, optimizing the loading time (read more on MDN). This attribute is only applied during editing to enhance the loading efficiency of images, and it does not reflect in the final data output.

We are greatly satisfied with the improved editor loading times. At the same time, we acknowledge some other problematic areas, and we will keep delivering more performance-related improvements in the future.