tiptap/docs/api/nodes/task-item.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

---
description: The actually task, without it the task list would be nothing.
2021-10-15 03:20:21 +08:00
icon: list-check
---
# TaskItem
2021-01-25 17:35:52 +08:00
[![Version](https://img.shields.io/npm/v/@tiptap/extension-task-item.svg?label=version)](https://www.npmjs.com/package/@tiptap/extension-task-item)
[![Downloads](https://img.shields.io/npm/dm/@tiptap/extension-task-item.svg)](https://npmcharts.com/compare/@tiptap/extension-task-item?minimal=true)
2020-11-06 05:16:18 +08:00
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.
2021-04-16 03:48:19 +08:00
This extension doesnt require any JavaScript framework, its based on Vanilla JavaScript.
## Installation
```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
```
2021-02-12 22:02:40 +08:00
This extension requires the [`TaskList`](/api/nodes/task-list) node.
## Settings
### HTMLAttributes
Custom HTML attributes that should be added to the rendered HTML tag.
```js
TaskItem.configure({
HTMLAttributes: {
class: 'my-custom-class',
},
})
```
2020-11-06 05:16:18 +08:00
## Keyboard shortcuts
| Command | Windows/Linux | macOS |
| --------------- | ------------------ | ------------------ |
| splitListItem() | `Enter` | `Enter` |
| sinkListItem() | `Tab` | `Tab` |
| liftListItem() | `Shift`&nbsp;`Tab` | `Shift`&nbsp;`Tab` |
## Source code
2021-04-21 21:31:11 +08:00
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-item/)
## Usage
<tiptap-demo name="Nodes/TaskItem"></tiptap-demo>