tiptap/docs/src/docPages/api/nodes/task-list.md

TaskList

This extension enables you to use task lists in the editor. They are rendered as <ul data-type="task_list">. This implementation doesn’t require any framework, it’s using plain JavaScript only.

Type [ ]  or [x]  at the beginning of a new line and it will magically transform to a task list.

Installation

::: warning Use with TaskItem This extension requires the TaskItem extension. :::

# with npm
npm install @tiptap/extension-task-list @tiptap/extension-task-item

# with Yarn
yarn add @tiptap/extension-task-list @tiptap/extension-task-item

Settings

Option	Type	Default	Description
HTMLAttributes	Object	{}	Custom HTML attributes that should be added to the rendered HTML tag.

Commands

Command	Parameters	Description
taskList	—	Toggle a task list.

Keyboard shortcuts

• Windows/Linux: Control Shift L
• macOS: Cmd Shift L

Source code

packages/extension-task-list/

Usage