探索 Tiptap V3 的最新功能

列表项扩展

版本下载量

列表项扩展添加对 <li> HTML 标签的支持。它用于无序列表和有序列表,实际上离不开这些列表。

修改退格行为

如果您想修改列表的退格和删除功能的标准行为,请阅读 ListKeymap 扩展。

安装

npm install @tiptap/extension-list

此扩展需要 BulletListOrderedList 节点。

使用

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

new Editor({
  extensions: [ListItem],
})

此扩展在默认情况下与 ListKit 扩展一起安装,因此您无需单独安装它。

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

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

设置

HTMLAttributes

应添加到渲染的 HTML 标签中的自定义 HTML 属性。

ListItem.configure({
  HTMLAttributes: {
    class: 'my-custom-class',
  },
})

快捷键

命令Windows/LinuxmacOS
splitListItem()EnterEnter
sinkListItem()TabTab
liftListItem()Shift + TabShift + Tab

源代码

packages/extension-list/src/item/

最小安装

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

new Editor({
  extensions: [ListItem],
})