Files
tiptap/docs/src/docPages/api/nodes/task-item.md
2020-11-18 12:12:34 +01:00

1.1 KiB
Raw Blame History

TaskItem

This extension renders a task item list element, which is a <li> tag with a data-type attribute set to taskItem. It also renders a checkbox inside the list element, which updates a checked attribute.

This extension doesnt require any JavaScript framework, its based on plain JavaScript.

Installation

::: warning Use with TaskList This extension requires the TaskList node. :::

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

# Or: 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.

Keyboard shortcuts

  • New list item: Enter

Source code

packages/extension-task-item/

Usage