项目

tiptap 任务列表

这个扩展允许你在编辑器中使用任务列表。它们将以 <ul data-type="taskList"> 的形式显示。此实现无需依赖任何框架,仅使用纯 JavaScript。

在新行开头键入 [ ] [x] ,它会神奇地变成任务列表。

安装

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

此扩展需要 TaskItem 扩展。

配置

HTMLAttributes

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

TaskList.configure({
  HTMLAttributes: {
    class: "my-custom-class",
  },
});

itemTypeName

指定列表项名称。

默认值: 'taskItem'

TaskList.configure({
  itemTypeName: "taskItem",
});

命令

toggleTaskList()

切换任务列表。

editor.commands.toggleTaskList();

快捷键

命令 Windows/Linux macOS
toggleTaskList() Ctrl + Shift + 9 Cmd + Shift + 9

源代码

packages/extension-task-list/

使用示例

https://embed.tiptap.dev/preview/Nodes/TaskList

在本文档中