mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-04 19:59:02 +08:00
33 lines
1.4 KiB
Markdown
33 lines
1.4 KiB
Markdown
# TaskItem
|
||
[](https://www.npmjs.com/package/@tiptap/extension-task-item)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-task-item?minimal=true)
|
||
|
||
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 doesn’t require any JavaScript framework, it’s 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
|
||
```
|
||
|
||
This extension requires the [`TaskList`](/api/nodes/task-list) node.
|
||
|
||
## 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/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-item/)
|
||
|
||
## Usage
|
||
<tiptap-demo name="Nodes/TaskItem"></tiptap-demo>
|