This extension enables you to use task lists in the editor. They are rendered as <ul data-type="taskList">. 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.

Install

npm install @tiptap/extension-list

This extension requires the TaskItem extension.

Usage

import { Editor } from '@tiptap/core'
import { TaskList } from '@tiptap/extension-list'

new Editor({
  extensions: [TaskList],
})

This extension is installed by default with the ListKit extension, so you don’t need to install it separately.

import { Editor } from '@tiptap/core'
import { ListKit } from '@tiptap/extension-list-kit'

new Editor({
  extensions: [ListKit],
})

Settings

HTMLAttributes

Custom HTML attributes that should be added to the rendered HTML tag.

TaskList.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

itemTypeName

Specify the list item name.

Default: 'taskItem'

TaskList.configure({
  itemTypeName: 'taskItem',
})

Commands

toggleTaskList()

Toggle a task list.

editor.commands.toggleTaskList()

Keyboard shortcuts

Source code

packages/extension-list/src/task-list/

Minimal Install

import { Editor } from '@tiptap/core'
import { TaskList } from '@tiptap/extension-list/task-list'

new Editor({
  extensions: [TaskList],
})