Multi-level lists

Multi-level lists with the legal style numbering feature allows for easy creation and modification of numbered lists with counters (1, 1.1, 1.1.1). These are crucial for clear referencing and hierarchical organization in complex documents. The feature offers full compatibility with Microsoft Word. When lists with such formatting are pasted to the editor with the paste from Office enhanced feature, the numbering format is retained.

# Demo

# Additional feature information

# Headings in multi-level lists

Multi-level lists support headings in list items. The marker, which denotes the counter, will insert itself into the heading block to achieve more similar styles.

While creation of a legal document with a list of numbered headings is possible, the editing of long-form documents may not be the best experience. You might want full support for the numbered headings feature that Microsoft Word places in the multi-level lists interface. We do not have it yet, but if you are interested, please let us know in this GitHub issue or via our support.

# Custom multi-level list styles

For now, we provide one style for multi-level lists: legal style numbering. But this first step opens a possibility for us to add more styles in the future or allow integrators to create their own styles. If you are interested, please let us know in this GitHub issue or via our support.

# Installation

To add this feature to your editor, install the @ckeditor/ckeditor5-list-multi-level package:

npm install --save @ckeditor/ckeditor5-list-multi-level

Then add the MultiLevelList plugin to your plugin list.

import { List } from '@ckeditor/ckeditor5-list';
import { MultiLevelList } from '@ckeditor/ckeditor5-list-multi-level';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ List, MultiLevelList, /* ... */ ],
        toolbar: [ 'multiLevelList', /* ... */ ],
    } )
    .then( /* ... */ )
    .catch( /* ... */ );

# Activating the feature

To use this premium feature, you need to activate it with proper credentials. Refer to the License key and activation guide for details.

# Related features

• Ordered and unordered lists – Create ordered and unordered lists with configurable markers.
• 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.
• Paste from Office enhanced – Paste Office documents with high compatibility.

# Common API

The MultiLevelList registers:

• The 'multiLevelList' UI dropdown component.
• The 'multiLevelList' command implemented by MultiLevelListCommand.

You can execute the command using the editor.execute() method:

// Change selected content to multi level list.
editor.execute( 'multiLevelList' );