2020-11-02 22:54:15 +08:00
|
|
|
|
# TaskItem
|
|
|
|
|
|
|
|
|
|
|
|
## Installation
|
2020-11-04 00:05:27 +08:00
|
|
|
|
::: warning Use with TaskList
|
|
|
|
|
|
This extension requires the [`TaskList`](/api/nodes/task-list) extension.
|
2020-11-02 22:54:15 +08:00
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
|
# 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 |
|
|
|
|
|
|
| ------ | ------ | ------- | -------------------------------------------- |
|
|
|
|
|
|
| class | string | – | Add a custom class to the rendered HTML tag. |
|
|
|
|
|
|
|
|
|
|
|
|
## Commands
|
|
|
|
|
|
*None*
|
|
|
|
|
|
|
|
|
|
|
|
## Source code
|
|
|
|
|
|
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-task-item/)
|
|
|
|
|
|
|
|
|
|
|
|
## Usage
|
2020-11-03 23:43:35 +08:00
|
|
|
|
<demo name="Nodes/TaskItem" />
|
