Document lists
The document list feature lets you create ordered and unordered lists. The unique thing about them is that you can put any content inside each list item (including block elements like paragraphs and tables), retaining the continuity of numbering and indentation.
The document lists feature will become the default list feature for CKEditor 5 in the upcoming releases and will replace the current one. This plugin will then be withdrawn at the beginning of 2024.
See #14767 for more details.
# Demo
Use the demo below to add block elements like tables, images, or nested lists. Notice that the document retains the ordering and list styles. Use the toolbar buttons to insert new ordered
and unordered lists .This demo only presents a limited set of features. Visit the feature-rich editor example to see more in action.
# List styles
Document lists offer additional formatting tools, just like regular lists. The list style feature introduces some more styles for the list item markers. When enabled, it adds 3 styles for unordered lists and 6 styles for ordered lists to choose from. The user will be able to set or change the list style via the dropdown that opens when you click the arrow next to the appropriate list button in the toolbar.
# List indentation
Refer to the Indenting lists section of the Block indentation feature guide.
# Installation
There are currently two plugins providing list support for CKEditor 5: the regular lists feature and this new document lists feature.
The document lists feature is not enabled in any builds, so you need to install it by hand.
# Document list feature
To add this feature to your editor, install the @ckeditor/ckeditor5-list
package:
npm install --save @ckeditor/ckeditor5-list
Then add the DocumentList
plugin to your plugin list and the toolbar configuration:
import { DocumentList } from '@ckeditor/ckeditor5-list';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ DocumentList, /* ... */ ],
toolbar: [ 'bulletedList', 'numberedList', /* ... */ ]
} )
.then( /* ... */ )
.catch( /* ... */ );
# Document list properties
To enable the list properties feature for document lists, install the @ckeditor/ckeditor5-list
package:
npm install --save @ckeditor/ckeditor5-list
Then add the DocumentListProperties
plugin to your plugin list and configure the toolbar. To enable selected sub-features of the list properties, you need to add their configuration to your editor (set true
for each feature you want to enable):
import { DocumentListProperties } from '@ckeditor/ckeditor5-list';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ DocumentListProperties, /* ... */ ],
toolbar: [ 'bulletedList', 'numberedList', /* ... */ ],
list: {
properties: {
styles: true,
startIndex: true,
reversed: true
}
}
} )
.then( /* ... */ )
.catch( /* ... */ );
Read more about installing plugins.
The DocumentListProperties
feature overrides UI button implementations from the ListUI
.
# List merging
By default, two lists of the same type (ordered and unordered) that are next to each other are merged together. This is done so that lists that visually appear to be one continuous list actually are, even if the user has accidentally created several of them.
Unfortunately, in some cases this can be undesirable behavior. For example, two adjacent numbered lists, each with two items, will merge into a single list with the numbers 1 through 4.
To prevent this behavior, enable the AdjacentListsSupport
plugin.
import AdjacentListsSupport from '@ckeditor/ckeditor5-list/src/documentlist/adjacentlistssupport.js';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [
AdjacentListsSupport,
/* Other plugins */
],
} )
.then( /* ... */ )
.catch( /* ... */ );
# Related features
These features also provide similar functionality:
- To-do lists – Create a list of interactive checkboxes with labels.
- Block indentation – Set indentation for text blocks such as paragraphs or headings and lists.
- Autoformatting – Format the text on the go with Markdown code.
# Common API
The DocumentList
plugin registers:
- The
'numberedList'
command. - The
'bulletedList'
command. - The
'indentList'
command. - The
'outdentList'
command. - The
'numberedList'
UI button. - The
'bulletedList'
UI button.
The DocumentListProperties
plugin registers:
-
The
documentListStyle
command that accepts thetype
of the list style to set. If not set, is uses the default marker (usually decimal).editor.execute( 'documentListStyle', { type: 'lower-roman' } );
The available types are:
- For bulleted lists:
'disc'
,'circle'
and'square'
. - For numbered lists:
'decimal'
,'decimal-leading-zero'
,'lower-roman'
,'upper-roman'
,'lower-latin'
and'upper-latin'
.
- For bulleted lists:
-
The
documentListStart
command which is a Number and defaults to1
(meaning a list starts with1
). If enabled, it accepts a numerical value for thestart
attribute.editor.execute( 'documentListStart', { startIndex: 3 } );
-
The
documentListReversed
command which is a Boolean and defaults tofalse
(meaning the list order is ascending).editor.execute( 'documentListReversed', { reversed: true } );
-
The
numberedList
UI split button that overrides the UI button registered by theList
plugin. -
The
bulletedList
UI split button that overrides the UI button registered by theList
plugin.
# Contribute
The source code of the feature is available on GitHub at https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-list.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.