feat(editor): indentation (#2174)

* switch to default codeblock tab handling

* feat(editor): indentation
This commit is contained in:
Philip Okugbe
2026-05-08 21:40:37 +01:00
committed by GitHub
parent c66c08fa78
commit 2d8b470495
10 changed files with 328 additions and 26 deletions
@@ -10,7 +10,9 @@ import { Typography } from "@tiptap/extension-typography";
import { TextStyle } from "@tiptap/extension-text-style";
import { Color } from "@tiptap/extension-color";
import { Youtube } from "@tiptap/extension-youtube";
import SlashCommand, { SlashCommandExtension as Command } from "@/features/editor/extensions/slash-command";
import SlashCommand, {
SlashCommandExtension as Command,
} from "@/features/editor/extensions/slash-command";
import renderItems from "@/features/editor/components/slash-menu/render-items";
import getSuggestionItems from "@/features/editor/components/slash-menu/menu-items";
import { Collaboration, isChangeOrigin } from "@tiptap/extension-collaboration";
@@ -46,6 +48,7 @@ import {
Subpages,
Heading,
Highlight,
Indent,
UniqueID,
SharedStorage,
Columns,
@@ -201,6 +204,7 @@ export const mainExtensions = [
showOnlyWhenEditable: true,
}),
TextAlign.configure({ types: ["heading", "paragraph"] }),
Indent,
TaskList,
TaskItem.configure({
nested: true,
@@ -311,6 +315,8 @@ export const mainExtensions = [
view: CodeBlockView,
//@ts-ignore
lowlight,
enableTabIndentation: true,
tabSize: 2,
HTMLAttributes: {
spellcheck: false,
},
@@ -405,7 +411,10 @@ const TEMPLATE_EXCLUDED_SLASH_ITEMS = new Set([
const TemplateSlashCommand = Command.configure({
suggestion: {
items: ({ query }: { query: string }) =>
getSuggestionItems({ query, excludeItems: TEMPLATE_EXCLUDED_SLASH_ITEMS }),
getSuggestionItems({
query,
excludeItems: TEMPLATE_EXCLUDED_SLASH_ITEMS,
}),
render: renderItems,
},
});
@@ -0,0 +1,14 @@
.ProseMirror {
--indent-step: 2rem;
}
.ProseMirror [data-indent="1"] { padding-inline-start: calc(var(--indent-step) * 1); }
.ProseMirror [data-indent="2"] { padding-inline-start: calc(var(--indent-step) * 2); }
.ProseMirror [data-indent="3"] { padding-inline-start: calc(var(--indent-step) * 3); }
.ProseMirror [data-indent="4"] { padding-inline-start: calc(var(--indent-step) * 4); }
.ProseMirror [data-indent="5"] { padding-inline-start: calc(var(--indent-step) * 5); }
.ProseMirror [data-indent="6"] { padding-inline-start: calc(var(--indent-step) * 6); }
.ProseMirror [data-indent="7"] { padding-inline-start: calc(var(--indent-step) * 7); }
.ProseMirror [data-indent="8"] { padding-inline-start: calc(var(--indent-step) * 8); }
.ProseMirror [data-indent="9"] { padding-inline-start: calc(var(--indent-step) * 9); }
.ProseMirror [data-indent="10"] { padding-inline-start: calc(var(--indent-step) * 10); }
@@ -13,5 +13,6 @@
@import "./mention.css";
@import "./ordered-list.css";
@import "./highlight.css";
@import "./indent.css";
@import "./columns.css";
@import "./status.css";
+2 -1
View File
@@ -163,10 +163,11 @@
"rootDir": "src",
"testRegex": ".*\\.spec\\.ts$",
"transform": {
"happy-dom.+\\.js$": ["babel-jest", { "presets": [["@babel/preset-env", { "targets": { "node": "current" } }]] }],
"^.+\\.(t|j)s$": "ts-jest"
},
"transformIgnorePatterns": [
"/node_modules/(?!(\\.pnpm/)?(nanoid|uuid|image-dimensions|marked)(@|/))"
"/node_modules/(?!(\\.pnpm/)?(nanoid|uuid|image-dimensions|marked|happy-dom)(@|/))"
],
"collectCoverageFrom": [
"**/*.(t|j)s"
@@ -34,6 +34,7 @@ import {
Mention,
Subpages,
Highlight,
Indent,
UniqueID,
Columns,
Column,
@@ -62,10 +63,11 @@ export const tiptapExtensions = [
}),
Heading,
UniqueID.configure({
types: ['heading', 'paragraph'],
types: ['heading', 'paragraph', 'transclusionSource'],
}),
Comment,
TextAlign.configure({ types: ['heading', 'paragraph'] }),
Indent,
TaskList,
TaskItem.configure({
nested: true,
@@ -0,0 +1,63 @@
import { htmlToJson, jsonToHtml } from '../../../collaboration/collaboration.util';
const findFirstChild = (
json: any,
type: string,
): any | undefined => {
if (!json || typeof json !== 'object') return undefined;
if (json.type === type) return json;
if (Array.isArray(json.content)) {
for (const child of json.content) {
const found = findFirstChild(child, type);
if (found) return found;
}
}
return undefined;
};
describe('indent attribute round-trip', () => {
it('parses data-indent on a paragraph into the indent attribute', () => {
const html = '<p data-indent="3">Hello</p>';
const json = htmlToJson(html);
const paragraph = findFirstChild(json, 'paragraph');
expect(paragraph).toBeDefined();
expect(paragraph.attrs.indent).toBe(3);
});
it('parses data-indent on a heading into the indent attribute', () => {
const html = '<h2 data-indent="2">Heading</h2>';
const json = htmlToJson(html);
const heading = findFirstChild(json, 'heading');
expect(heading).toBeDefined();
expect(heading.attrs.indent).toBe(2);
expect(heading.attrs.level).toBe(2);
});
it('clamps out-of-range data-indent values', () => {
const html = '<p data-indent="42">Too deep</p>';
const json = htmlToJson(html);
const paragraph = findFirstChild(json, 'paragraph');
expect(paragraph.attrs.indent).toBe(8);
});
it('renders nonzero indent back to data-indent on HTML serialization', () => {
const html = '<p data-indent="4">Round-trip</p>';
const json = htmlToJson(html);
const out = jsonToHtml(json);
expect(out).toContain('data-indent="4"');
});
it('omits data-indent for indent zero', () => {
const html = '<p>No indent</p>';
const json = htmlToJson(html);
const out = jsonToHtml(json);
expect(out).not.toContain('data-indent');
});
it('preserves indent through HTML → JSON → HTML', () => {
const original = '<p data-indent="5">Five deep</p>';
const json = htmlToJson(original);
const final = jsonToHtml(json);
expect(final).toContain('data-indent="5"');
});
});