add basic task list and task item extension

This commit is contained in:
Philipp Kühn
2020-10-30 13:19:06 +01:00
parent f9089932ff
commit 3e00fadcaa
10 changed files with 232 additions and 5 deletions

View File

@@ -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,
}
}

View File

@@ -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"
}
}