ListKit 扩展

ListKit 是一个包含所有必要的 Tiptap 列表扩展的集合。如果你想快速在 Tiptap 中设置列表，这个扩展非常适合你。

安装

npm install @tiptap/extension-list

包含的扩展

节点

BulletList
ListItem
OrderedList
TaskItem
TaskList

扩展

ListKeymap

源代码

packages/extension-list/

使用 ListKit 扩展

将 ListKit 传递给编辑器以一次加载所有包含的扩展。

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

const editor = new Editor({
  extensions: [ListKit],
})

你可以配置包含的扩展，甚至可以禁用其中的一些，如下所示。

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

const editor = new Editor({
  extensions: [
    ListKit.configure({
      // 禁用扩展
      bulletList: false,

      // 配置扩展
      listItem: {
        HTMLAttributes: { class: 'list-item' },
      },
    }),
  ],
})