Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import { offset } from '@floating-ui/dom';
import { incrementBlockGripClickSelectFailed } from '@inkeep/open-knowledge-core/metrics/parse-health';
import { t } from '@lingui/core/macro';
import { type Editor, Extension } from '@tiptap/core';
import { DragHandlePlugin, normalizeNestedOptions } from '@tiptap/extension-drag-handle';
import type { Node as PmNode } from '@tiptap/pm/model';
import { Plugin, PluginKey, TextSelection } from '@tiptap/pm/state';
import { createDragMenuLifecycle } from '../bubble-menu/drag-menu-lifecycle.ts';
import { OPT_OUT_ATTR } from '../clipboard/index.ts';
import { getDescriptor } from '../registry/index.ts';
import { createChildNode, focusInsertedComponent } from '../slash-command/component-items.tsx';
import { GUTTER_PLUS_SVG } from './gutter-plus-icon.ts';
import { createListItemDragController } from './list-item-drag.ts';
const HANDLE_HEIGHT = 20;
const MAX_SINGLE_LINE_HEIGHT = 44;
const BODY_LINE_HEIGHT = 28;
export const blockDragHoverKey = new PluginKey('blockDragHover');
function selectNamed(name: string): string {
return t`Select ${name}`;
}
function describeBlockForGrip(node: PmNode | null): string {
if (!node) return t`Select block`;
if (node.type.name === 'listItem') return t`Select list item`;
if (node.type.name === 'jsxComponent') {
const componentName = (node.attrs.componentName as string | undefined) ?? '';
if (componentName) {
const descriptor = getDescriptor(componentName);
const label =
descriptor.name === '*' ? componentName : (descriptor.displayName ?? descriptor.name);
if (label) return selectNamed(label);
}
}
return selectNamed(node.type.name);
}
function createBlockControlsElement(): {
container: HTMLElement;
addBtn: HTMLButtonElement;
grip: HTMLButtonElement;
} {
const container = document.createElement('div');
container.className = 'ok-block-controls';
container.setAttribute(OPT_OUT_ATTR, 'true');
container.style.visibility = 'hidden';
const addBtn = document.createElement('button');
addBtn.className = 'ok-add-block-btn';
addBtn.setAttribute('aria-label', t`Add block below`);
addBtn.setAttribute('type', 'button');
addBtn.innerHTML = GUTTER_PLUS_SVG;
addBtn.addEventListener('mousedown', (e) => {
e.preventDefault();
e.stopPropagation();
});
const grip = document.createElement('button');
grip.className = 'ok-drag-grip';
grip.setAttribute('type', 'button');
grip.setAttribute('aria-label', t`Select block`);
grip.setAttribute('tabindex', '-1');
grip.innerHTML = `<svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-grip-vertical-icon lucide-grip-vertical"><circle cx="9" cy="12" r="1"/><circle cx="9" cy="5" r="1"/><circle cx="9" cy="19" r="1"/><circle cx="15" cy="12" r="1"/><circle cx="15" cy="5" r="1"/><circle cx="15" cy="19" r="1"/></svg>`;
container.appendChild(addBtn);
container.appendChild(grip);
return { container, addBtn, grip };
}
function addBlockBelow(editor: Editor, hoveredNodePos: number, hoveredNode: PmNode): void {
const { state, view } = editor;
if (hoveredNode.type.name === 'listItem') {
const $pos = state.doc.resolve(hoveredNodePos);
addBlockBelow(editor, $pos.before(1), $pos.node(1));
return;
}
if (hoveredNode.type.name === 'jsxComponent') {
const componentName = (hoveredNode.attrs.componentName as string | undefined) ?? '';
if (componentName) {
const descriptor = getDescriptor(componentName);
if (descriptor.emptyChildName) {
const insertPos = hoveredNodePos + 1 + hoveredNode.content.size;
if (insertPos > state.doc.content.size) return;
const childName = descriptor.emptyChildName;
editor.chain().focus().insertContentAt(insertPos, createChildNode(childName)).run();
focusInsertedComponent(editor, insertPos, getDescriptor(childName));
return;
}
}
}
const insertAt = hoveredNodePos + hoveredNode.nodeSize;
if (insertAt > state.doc.content.size) return;
const { tr } = state;
const paragraph = state.schema.nodes.paragraph?.create();
if (!paragraph) return;
tr.insert(insertAt, paragraph);
const sel = TextSelection.near(tr.doc.resolve(insertAt + 1));
tr.setSelection(sel).scrollIntoView();
view.dispatch(tr);
view.focus();
editor.commands.insertContent('/');
}
export const BlockDragHandle = Extension.create({
name: 'blockDragHandle',
addProseMirrorPlugins() {
const editor = this.editor;
let currentNode: PmNode | null = null;
let currentNodePos = -1;
const { container, addBtn, grip } = createBlockControlsElement();
const listItemDrag = createListItemDragController();
const dragMenu = createDragMenuLifecycle(editor);
editor.on('destroy', listItemDrag.destroy);
editor.on('destroy', dragMenu.destroy);
container.addEventListener(
'dragstart',
(event) => {
if (event.dataTransfer && editor.view.editable) dragMenu.start(editor.view);
const handled = listItemDrag.start(event, editor.view, currentNode, currentNodePos);
if (handled) {
event.stopImmediatePropagation();
}
},
{ capture: true },
);
addBtn.addEventListener('click', () => {
if (currentNode && currentNodePos >= 0) {
addBlockBelow(editor, currentNodePos, currentNode);
}
});
grip.addEventListener('click', () => {
if (currentNodePos < 0) return;
const targetNode = currentNode;
const nodeType = targetNode?.type.name ?? 'unknown';
try {
const dispatched = editor.chain().focus().setNodeSelection(currentNodePos).run();
if (!dispatched) {
incrementBlockGripClickSelectFailed(nodeType);
console.warn(
JSON.stringify({
event: 'block-grip-click-select-failed',
nodeType,
componentName: String(targetNode?.attrs.componentName ?? '').slice(0, 200),
reason: 'chain-dispatch-returned-false',
}),
);
}
} catch (err) {
if (!(err instanceof RangeError)) throw err;
incrementBlockGripClickSelectFailed(nodeType);
console.warn(
JSON.stringify({
event: 'block-grip-click-select-failed',
nodeType,
componentName: String(targetNode?.attrs.componentName ?? '').slice(0, 200),
reason: err.message.slice(0, 500),
}),
);
}
});
function retainedListItemPoint(event: MouseEvent) {
if (
currentNode?.type.name !== 'listItem' ||
currentNodePos < 0 ||
container.style.visibility === 'hidden'
) {
return null;
}
const item = editor.view.nodeDOM(currentNodePos);
if (!(item instanceof HTMLElement)) return null;
const itemRect = item.getBoundingClientRect();
const controlsRect = container.getBoundingClientRect();
const lineHeight = Math.min(itemRect.height, BODY_LINE_HEIGHT);
if (
event.clientX < controlsRect.left ||
event.clientX > itemRect.left ||
event.clientY < itemRect.top ||
event.clientY > itemRect.top + lineHeight
) {
return null;
}
return { x: itemRect.left + Math.min(2, itemRect.width / 2), y: event.clientY };
}
const dragHandle = DragHandlePlugin({
element: container,
editor,
onElementDragEnd() {
const { view } = editor;
view.dispatch(view.state.tr.setMeta('hideDragHandle', true));
},
onNodeChange({ node, pos }: { node: PmNode | null; pos: number }) {
currentNode = node;
currentNodePos = pos ?? -1;
grip.setAttribute('aria-label', describeBlockForGrip(node));
addBtn.setAttribute('aria-label', t`Add block below`);
},
getReferencedVirtualElement() {
if (currentNode?.type.name !== 'listItem' || currentNodePos < 0) return null;
const item = editor.view.nodeDOM(currentNodePos);
if (!(item instanceof HTMLElement)) return null;
const list = item.parentElement;
if (!list?.matches('ul, ol')) return null;
return {
contextElement: item,
getBoundingClientRect() {
const itemRect = item.getBoundingClientRect();
const listRect = list.getBoundingClientRect();
return new DOMRect(listRect.left, itemRect.top, listRect.width, itemRect.height);
},
};
},
computePositionConfig: {
placement: 'left-start',
strategy: 'absolute',
middleware: [
offset(({ rects }) => {
const firstLineHeight =
rects.reference.height <= MAX_SINGLE_LINE_HEIGHT
? rects.reference.height
: BODY_LINE_HEIGHT;
return {
mainAxis: 10,
crossAxis: (firstLineHeight - HANDLE_HEIGHT) / 2,
};
}),
],
},
nestedOptions: normalizeNestedOptions({
edgeDetection: 'none',
defaultRules: false,
rules: [
{
id: 'list-items-and-top-level-blocks',
evaluate: ({ node, depth }) => {
if (node.type.name === 'listItem') {
return 0;
}
return depth === 1 && node.type.name !== 'list' ? 0 : 1000;
},
},
],
}),
}).plugin;
return [
listItemDrag.plugin,
new Plugin({
key: blockDragHoverKey,
appendTransaction(transactions, _oldState, state) {
if (currentNode && transactions.some((transaction) => transaction.docChanged)) {
return state.tr.setMeta('hideDragHandle', true);
}
return null;
},
props: {
handleDOMEvents: {
mousemove(view, event) {
const point = retainedListItemPoint(event);
if (!point) return false;
dragHandle.props.handleDOMEvents?.mousemove?.call(
dragHandle,
view,
new MouseEvent('mousemove', {
bubbles: event.bubbles,
cancelable: event.cancelable,
clientX: point.x,
clientY: point.y,
buttons: event.buttons,
button: event.button,
altKey: event.altKey,
ctrlKey: event.ctrlKey,
metaKey: event.metaKey,
shiftKey: event.shiftKey,
}),
);
return true;
},
mouseleave(_view, event) {
return retainedListItemPoint(event) !== null;
},
},
},
}),
dragHandle,
];
},
});