@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.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.