tiptap 中文文档

tiptap BulletList 无序序列扩展

tiptap BulletList 扩展可以在编辑器中使用符号列表,它们被呈现为 HTML 的 ul 标签

Install 安装

npm install @tiptap/extension-bullet-list @tiptap/extension-list-item

扩展需要安装 ListItem 节点。

Settings 配置

HTMLAttributes 自定义HTML属性。

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

itemTypeName 制定列的项名,默认listItem。

BulletList.configure({
  itemTypeName: 'listItem',
})

keepMarks 是否保留转换为无序列之前的mark标记,默认为false。

BulletList.configure({
  keepMarks: true,
})

keepAttributes 是否保留转换为无序列之前的属性,默认为false。

BulletList.configure({
  keepAttributes: true,
})

Commands 命令

toggleBulletList 将选中内容转换为无序列。

editor.commands.toggleBulletList()

Shortcuts 快捷键

Windows/Linux Control Shift 8
   macOS Cmd Shift 8

源代码

extension-bullet-list

在线例子

在线例子

Catalog
快速入门 Guide 向导 API 列表 tiptap 方法 tiptap 属性 titap 配置 commands 命令 nodes 节点 Blockquote 引用扩展 BulletList 无序序列扩展 CodeBlock 代码块扩展 CodeBlockLowlight 代码高亮 Document 节点 HardBreak 换行节点 Heading 标题节点 HorizontalRule 横线节点 Image 图片扩展 ListItem 节点 Mention 提及节点 OrderedList 有序列节点 Paragraph 段落节点 Table 表格扩展 TaskList 任务列表 TaskItem 任务列表项 Text 节点 marks 标记 extensions 扩展