mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-25 02:07:49 +08:00
7e7057ea43
* move list keymap to extra extension * update docs and readme * move list helpers out of core
53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
---
|
|
description: Add extra keymap handlers to change the default backspace and delete behavior for lists.
|
|
icon: asterisk
|
|
---
|
|
|
|
# ListKeymap
|
|
[](https://www.npmjs.com/package/@tiptap/extension-list-keymap)
|
|
[](https://npmcharts.com/compare/@tiptap/extension-list-keymap?minimal=true)
|
|
|
|
This extensions adds extra keymap handlers to change the default backspace and delete behavior for lists. Those are not included in the core package, because they are not required for the most basic use cases.
|
|
|
|
## Installation
|
|
```bash
|
|
npm install @tiptap/extension-list-keymap
|
|
```
|
|
|
|
## Settings
|
|
|
|
### listTypes
|
|
A array of list items and their parent wrapper node types.
|
|
|
|
Default:
|
|
|
|
```js
|
|
[
|
|
{
|
|
itemName: 'listItem',
|
|
wrapperNames: ['bulletList', 'orderedList'],
|
|
},
|
|
{
|
|
itemName: 'taskItem',
|
|
wrapperNames: ['taskList'],
|
|
},
|
|
]
|
|
```
|
|
|
|
```js
|
|
ListKeymap.configure({
|
|
listTypes: [
|
|
{
|
|
itemName: 'taskItem',
|
|
wrapperNames: ['customTaskList'],
|
|
},
|
|
],
|
|
})
|
|
```
|
|
|
|
## Source code
|
|
[packages/extension-list-keymap/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list-keymap/)
|
|
|
|
## Usage
|
|
https://embed.tiptap.dev/preview/Extensions/ListKeymap
|