1.7 KiB
1.7 KiB
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 Vanilla JavaScript only.
Type [ ] or [x] at the beginning of a new line and it will magically transform to a task list.
Installation
# with npm
npm install @tiptap/extension-task-list @tiptap/extension-task-item
# with Yarn
yarn add @tiptap/extension-task-list @tiptap/extension-task-item
This extension requires the TaskItem extension.
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:
ControlShift9 - macOS:
CmdShift9