mirror of
https://github.com/outline/outline.git
synced 2026-11-22 05:51:43 +03:00
Typing "[ ] " at the start of an existing bullet or ordered list item now converts the whole list to a checklist, preserving nested list structure, reusing the in-place list conversion utility. https://claude.ai/code/session_01BGH191WyuL9SgQyjfJ3YsD
108 lines
2.8 KiB
TypeScript
108 lines
2.8 KiB
TypeScript
import type {
|
|
NodeSpec,
|
|
NodeType,
|
|
Schema,
|
|
Node as ProsemirrorNode,
|
|
} from "prosemirror-model";
|
|
import { Plugin } from "prosemirror-state";
|
|
import { v4 as generateUuid } from "uuid";
|
|
import toggleList from "../commands/toggleList";
|
|
import type { MarkdownSerializerState } from "../lib/markdown/serializer";
|
|
import {
|
|
checkboxListInputRule,
|
|
listWrappingInputRule,
|
|
} from "../lib/listInputRule";
|
|
import { findBlockNodes } from "../queries/findChildren";
|
|
import { CheckboxListView } from "./CheckboxListView";
|
|
import Node from "./Node";
|
|
|
|
export default class CheckboxList extends Node {
|
|
get name() {
|
|
return "checkbox_list";
|
|
}
|
|
|
|
get schema(): NodeSpec {
|
|
return {
|
|
group: "block list",
|
|
content: "checkbox_item+",
|
|
attrs: {
|
|
id: { default: null },
|
|
},
|
|
toDOM: () => ["ul", { class: this.name }, 0],
|
|
parseDOM: [
|
|
{
|
|
tag: `[class="${this.name}"]`,
|
|
},
|
|
],
|
|
};
|
|
}
|
|
|
|
get plugins() {
|
|
const userIdentifier = this.editor.props.userId;
|
|
|
|
// Plugin to auto-assign IDs to checkbox lists
|
|
const assignIdsPlugin = new Plugin({
|
|
appendTransaction: (txs, _oldSt, newSt) => {
|
|
const hasDocChanges = txs.some((t) => t.docChanged);
|
|
if (!hasDocChanges) {
|
|
return null;
|
|
}
|
|
|
|
const checkboxLists = findBlockNodes(newSt.doc, true).filter(
|
|
(b) => b.node.type.name === this.name && !b.node.attrs.id
|
|
);
|
|
|
|
if (checkboxLists.length === 0) {
|
|
return null;
|
|
}
|
|
|
|
let modifyTx = newSt.tr;
|
|
checkboxLists.forEach((listBlock) => {
|
|
modifyTx.setNodeAttribute(listBlock.pos, "id", generateUuid());
|
|
});
|
|
return modifyTx;
|
|
},
|
|
});
|
|
|
|
// Plugin to provide NodeViews
|
|
const nodeViewPlugin = new Plugin({
|
|
props: {
|
|
nodeViews: {
|
|
[this.name]: (node, view, getPos) =>
|
|
new CheckboxListView(node, view, getPos, userIdentifier || ""),
|
|
},
|
|
},
|
|
});
|
|
|
|
return [assignIdsPlugin, nodeViewPlugin];
|
|
}
|
|
|
|
keys({ type, schema }: { type: NodeType; schema: Schema }) {
|
|
return {
|
|
"Shift-Ctrl-7": toggleList(type, schema.nodes.checkbox_item),
|
|
};
|
|
}
|
|
|
|
commands({ type, schema }: { type: NodeType; schema: Schema }) {
|
|
return () => toggleList(type, schema.nodes.checkbox_item);
|
|
}
|
|
|
|
inputRules({ type, schema }: { type: NodeType; schema: Schema }) {
|
|
const pattern = /^-?\s*(\[\s?\])\s$/i;
|
|
return [
|
|
// Convert an existing plain list to a checklist, keeping nesting intact.
|
|
checkboxListInputRule(pattern, type, schema.nodes.checkbox_item),
|
|
// Wrap a plain paragraph into a new checklist.
|
|
listWrappingInputRule(pattern, type),
|
|
];
|
|
}
|
|
|
|
toMarkdown(state: MarkdownSerializerState, node: ProsemirrorNode) {
|
|
state.renderList(node, " ", () => "- ");
|
|
}
|
|
|
|
parseMarkdown() {
|
|
return { block: "checkbox_list" };
|
|
}
|
|
}
|