add basic task list and task item extension

packages/extension-bullet-list/index.ts

@@ -4,10 +4,10 @@ import { wrappingInputRule } from 'prosemirror-inputrules'
 const BulletList = createNode({
   name: 'bullet_list',
 
-  content: 'list_item+',
-
   group: 'block',
 
+  content: 'list_item+',
+
   parseHTML() {
     return [
       { tag: 'ul' },

packages/extension-list-item/index.ts

@@ -9,7 +9,9 @@ const ListItem = createNode({
 
   parseHTML() {
     return [
-      { tag: 'li' },
+      {
+        tag: 'li',
+      },
     ]
   },
 

packages/extension-ordered-list/index.ts

@@ -4,10 +4,10 @@ import { wrappingInputRule } from 'prosemirror-inputrules'
 const OrderedList = createNode({
   name: 'ordered_list',
 
-  content: 'list_item+',
-
   group: 'block',
 
+  content: 'list_item+',
+
   addAttributes() {
     return {
       start: {

packages/extension-task-item/index.ts

@@ -0,0 +1,59 @@
+import { createNode, mergeAttributes } from '@tiptap/core'
+
+export interface TaskItemOptions {
+  nested: boolean,
+}
+
+const TaskItem = createNode({
+  name: 'task_item',
+
+  content: 'paragraph+',
+
+  // TODO: allow content to be a callback function
+  // content() {
+  //   return this.options.nested ? '(paragraph|todo_list)+' : 'paragraph+',
+  // },
+
+  defining: true,
+
+  defaultOptions: <TaskItemOptions>{
+    nested: false,
+  },
+
+  addAttributes() {
+    return {
+      done: {
+        default: false,
+      },
+    }
+  },
+
+  parseHTML() {
+    return [
+      {
+        tag: 'li[data-type="task_item"]',
+        priority: 51,
+      },
+    ]
+  },
+
+  renderHTML({ attributes }) {
+    return ['li', mergeAttributes(attributes, { 'data-type': 'task_item' }), 0]
+  },
+
+  addKeyboardShortcuts() {
+    return {
+      Enter: () => this.editor.splitListItem('task_item'),
+      Tab: () => this.editor.sinkListItem('task_item'),
+      'Shift-Tab': () => this.editor.liftListItem('task_item'),
+    }
+  },
+})
+
+export default TaskItem
+
+declare module '@tiptap/core/src/Editor' {
+  interface AllExtensions {
+    TaskItem: typeof TaskItem,
+  }
+}

packages/extension-task-item/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@tiptap/extension-task-item",
+  "version": "1.0.0",
+  "source": "index.ts",
+  "main": "dist/tiptap-extension-task-item.js",
+  "umd:main": "dist/tiptap-extension-task-item.umd.js",
+  "module": "dist/tiptap-extension-task-item.mjs",
+  "unpkg": "dist/tiptap-extension-task-item.js",
+  "jsdelivr": "dist/tiptap-extension-task-item.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "peerDependencies": {
+    "@tiptap/core": "2.x"
+  }
+}

packages/extension-task-list/index.ts

@@ -0,0 +1,45 @@
+import { Command, createNode, mergeAttributes } from '@tiptap/core'
+import { wrappingInputRule } from 'prosemirror-inputrules'
+
+const TaskList = createNode({
+  name: 'task_list',
+
+  group: 'block',
+
+  content: 'task_item+',
+
+  parseHTML() {
+    return [
+      {
+        tag: 'ul[data-type="task_list"]',
+        priority: 51,
+      },
+    ]
+  },
+
+  renderHTML({ attributes }) {
+    return ['ul', mergeAttributes(attributes, { 'data-type': 'task_list' }), 0]
+  },
+
+  addCommands() {
+    return {
+      taskList: (): Command => ({ commands }) => {
+        return commands.toggleList('task_list', 'task_item')
+      },
+    }
+  },
+
+  addInputRules() {
+    return [
+      wrappingInputRule(/^\s*(\[ \])\s$/, this.type),
+    ]
+  },
+})
+
+export default TaskList
+
+declare module '@tiptap/core/src/Editor' {
+  interface AllExtensions {
+    TaskList: typeof TaskList,
+  }
+}

packages/extension-task-list/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@tiptap/extension-task-list",
+  "version": "1.0.0",
+  "source": "index.ts",
+  "main": "dist/tiptap-extension-task-list.js",
+  "umd:main": "dist/tiptap-extension-task-list.umd.js",
+  "module": "dist/tiptap-extension-task-list.mjs",
+  "unpkg": "dist/tiptap-extension-task-list.js",
+  "jsdelivr": "dist/tiptap-extension-task-list.js",
+  "files": [
+    "src",
+    "dist"
+  ],
+  "peerDependencies": {
+    "@tiptap/core": "2.x"
+  }
+}