To-do lists
The to-do list feature lets you create a list of interactive checkboxes with labels. It supports all features of bulleted and numbered lists, so you can nest a to-do list together with any combination of other lists.
# Demo
Use the to-do list toolbar button autoformatting feature, you can also start a line with [ ]
or [x]
followed by a space to insert an unchecked or checked list item.
This demo presents a limited set of features. Visit the feature-rich editor example to see more in action.
# Keyboard support
You can check and clear a list item by using the Ctrl + Enter (Cmd + Enter on Mac) shortcut when the selection is in that item.
# Related features
These CKEditor 5 features provide similar functionality:
- Ordered and unordered lists – Create ordered and unordered lists with configurable markers.
- Autoformatting – Format the text on the go with Markdown code.
# Common API
The TodoList
plugin registers:
- The
'todoList'
command. - The
'checkTodoList'
command. - The
'todoList'
UI button.
# 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.