Make option a callback, update docs
This commit is contained in:
@@ -4,6 +4,7 @@ icon: task-line
|
||||
---
|
||||
|
||||
# TaskItem
|
||||
|
||||
[](https://www.npmjs.com/package/@tiptap/extension-task-item)
|
||||
[](https://npmcharts.com/compare/@tiptap/extension-task-item?minimal=true)
|
||||
|
||||
@@ -12,6 +13,7 @@ This extension renders a task item list element, which is a `<li>` tag with a `d
|
||||
This extension doesn’t require any JavaScript framework, it’s based on Vanilla JavaScript.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @tiptap/extension-task-list @tiptap/extension-task-item
|
||||
```
|
||||
@@ -21,6 +23,7 @@ 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
|
||||
@@ -31,7 +34,32 @@ TaskItem.configure({
|
||||
})
|
||||
```
|
||||
|
||||
### nested
|
||||
|
||||
Whether the task items are allowed to be nested within each other.
|
||||
|
||||
```js
|
||||
TaskItem.configure({
|
||||
nested: true,
|
||||
})
|
||||
```
|
||||
|
||||
### onReadOnlyChecked
|
||||
|
||||
A handler for when the task item is checked or unchecked while the editor is set to `readOnly`.
|
||||
|
||||
If this is not supplied, the task items are immutable while the editor is `readOnly`.
|
||||
|
||||
```js
|
||||
TaskItem.configure({
|
||||
onReadOnlyChecked: (node, checked) => {
|
||||
// do something
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
## Keyboard shortcuts
|
||||
|
||||
| Command | Windows/Linux | macOS |
|
||||
| --------------- | ------------------ | ------------------ |
|
||||
| splitListItem() | `Enter` | `Enter` |
|
||||
@@ -39,7 +67,9 @@ TaskItem.configure({
|
||||
| liftListItem() | `Shift` `Tab` | `Shift` `Tab` |
|
||||
|
||||
## Source code
|
||||
|
||||
[packages/extension-task-item/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-task-item/)
|
||||
|
||||
## Usage
|
||||
|
||||
https://embed.tiptap.dev/preview/Nodes/TaskItem
|
||||
|
||||
Reference in New Issue
Block a user