Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix anchor positioning for identical table of contents names #5101

Merged
merged 3 commits into from
Dec 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 30 additions & 22 deletions console/packages/editor/src/extensions/heading/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,13 @@ import MdiFormatHeader6 from "~icons/mdi/format-header-6";
import { markRaw } from "vue";
import { i18n } from "@/locales";
import type { ExtensionOptions } from "@/types";
import { Decoration, DecorationSet, Plugin, PluginKey } from "@/tiptap";
import { ExtensionHeading } from "..";
import { generateAnchor } from "@/utils";
import { AttrStep, Plugin, PluginKey } from "@/tiptap";
import { generateAnchorId } from "@/utils";

const Blockquote = TiptapHeading.extend<ExtensionOptions & HeadingOptions>({
renderHTML({ node, HTMLAttributes }) {
const hasLevel = this.options.levels.includes(node.attrs.level);
const level = hasLevel ? node.attrs.level : this.options.levels[0];
const id = generateAnchor(node.textContent);
HTMLAttributes.id = id;

return [
`h${level}`,
mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
Expand Down Expand Up @@ -282,27 +278,39 @@ const Blockquote = TiptapHeading.extend<ExtensionOptions & HeadingOptions>({
return [TiptapParagraph];
},
addProseMirrorPlugins() {
let beforeComposition: boolean | undefined = undefined;
return [
new Plugin({
key: new PluginKey("generate-heading-id"),
props: {
decorations: (state) => {
const { doc } = state;
const decorations: Decoration[] = [];
doc.descendants((node, pos) => {
if (node.type.name === ExtensionHeading.name) {
const id = generateAnchor(node.textContent);
if (node.attrs.id !== id) {
decorations.push(
Decoration.node(pos, pos + node.nodeSize, {
id,
})
);
}
appendTransaction: (transactions, oldState, newState) => {
const isChangeHeading = transactions.some((transaction) => {
const composition = this.editor.view.composing;
if (beforeComposition !== undefined && !composition) {
beforeComposition = undefined;
return true;
}
if (transaction.docChanged) {
beforeComposition = composition;
const selection = transaction.selection;
const { $from } = selection;
const node = $from.parent;
return node.type.name === Blockquote.name && !composition;
}
return false;
});
if (isChangeHeading) {
const tr = newState.tr;
const headingIds: string[] = [];
newState.doc.descendants((node, pos) => {
if (node.type.name === Blockquote.name) {
const id = generateAnchorId(node.textContent, headingIds);
tr.step(new AttrStep(pos, "id", id));
headingIds.push(id);
}
});
return DecorationSet.create(doc, decorations);
},
return tr;
}
return undefined;
},
}),
];
Expand Down
15 changes: 15 additions & 0 deletions console/packages/editor/src/utils/anchor.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,18 @@ export function generateAnchor(text: string) {
String(text).trim().toLowerCase().replace(/\s+/g, "-")
);
}

export const generateAnchorId = (text: string, ids: string[]) => {
const originId = generateAnchor(text);
let id = originId;
while (ids.includes(id)) {
const temporarySuffix = id.replace(originId, "");
const match = temporarySuffix.match(/-(\d+)$/);
if (match) {
id = `${originId}-${Number(match[1]) + 1}`;
} else {
id = `${originId}-1`;
}
}
return id;
};
Loading