---
title: "列表键盘映射扩展"
description: "添加额外的键盘映射处理程序，以改变列表的默认退格和删除行为。更多信息请查看我们的文档！"
canonical_url: "https://tiptap.zhcndoc.com/editor/extensions/functionality/listkeymap"
---

# 列表键盘映射扩展

添加额外的键盘映射处理程序，以改变列表的默认退格和删除行为。更多信息请查看我们的文档！

列表键盘映射扩展修改了默认的 ProseMirror 和 Tiptap 行为。如果没有这个扩展，在列表项开头按退格键会将列表项内容保留在同一行。使用列表键盘映射时，内容会提升到上方的列表项中。

> **Interactive demo:** [ListKeymap](https://embed.tiptap.dev/preview/Extensions/ListKeymap)

## 安装

```bash
npm install @tiptap/extension-list
```

并在编辑器中导入它：

```ts
import { Editor } from '@tiptap/core'
import { ListKeymap } from '@tiptap/extension-list'

new Editor({
  extensions: [ListKeymap],
})
```

此扩展默认与 `ListKit` 扩展一起安装，因此您无需单独安装它。

```ts
import { Editor } from '@tiptap/core'
import { ListKit } from '@tiptap/extension-list'

new Editor({
  extensions: [ListKit],
})
```

## 设置

### listTypes

列表项及其父包裹节点类型的数组。

```js
ListKeymap.configure({
  listTypes: [
    {
      itemName: 'taskItem',
      wrapperNames: ['customTaskList'],
    },
  ],
})
```

默认值：

```json
[
  {
    "itemName": "listItem",
    "wrapperNames": ["bulletList", "orderedList"]
  },
  {
    "itemName": "taskItem",
    "wrapperNames": ["taskList"]
  }
]
```

## 源代码

[packages/extension-list/src/keymap/](https://github.com/ueberdosis/tiptap/blob/main/packages/extension-list/src/keymap/)

## 最小安装

```js
import { Editor } from '@tiptap/core'
import { ListKeymap } from '@tiptap/extension-list/keymap'

new Editor({
  extensions: [ListKeymap],
})
```