Skip to content

Fix Mermaid diagrams failing when node labels contain line breaks #37296

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.

Sign up for GitHub

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

Merged
silverwind merged 3 commits into from
Apr 19, 2026
Merged

Fix Mermaid diagrams failing when node labels contain line breaks #37296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07ffa02
disable html tags which break rendering
bircni Apr 19, 2026
bb25bd1
fix
wxiaoguang Apr 19, 2026
501460e
fix lint
wxiaoguang Apr 19, 2026
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
2 changes: 1 addition & 1 deletion web_src/js/features/repo-issue-pull.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ async function initRepoPullRequestMergeForm(box: HTMLElement) {
view.mount(el);
}

function executeScripts(elem: HTMLElement) {
function executeScripts(elem: Element) {
// find any existing nonce value from the current page and apply it to the new script
const scriptNonce = document.querySelector('script[nonce]')!.getAttribute('nonce')!;
for (const oldScript of elem.querySelectorAll('script')) {
Expand Down
7 changes: 3 additions & 4 deletions web_src/js/markup/mermaid.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {isDarkTheme, parseDom} from '../utils.ts';
import {isDarkTheme} from '../utils.ts';
import {displayError} from './common.ts';
import {createElementFromAttrs, createElementFromHTML, queryElems} from '../utils/dom.ts';
import {html, htmlRaw} from '../utils/html.ts';
Expand Down Expand Up @@ -81,7 +81,7 @@ async function loadMermaid(needElkRender: boolean) {
};
}

function initMermaidViewController(viewController: HTMLElement, dragElement: SVGSVGElement) {
function initMermaidViewController(viewController: Element, dragElement: SVGSVGElement) {
let inited = false, isDragging = false;
let currentScale = 1, initLeft = 0, lastLeft = 0, lastTop = 0, lastPageX = 0, lastPageY = 0;

Expand Down Expand Up @@ -201,8 +201,7 @@ export async function initMarkupCodeMermaid(elMarkup: HTMLElement): Promise<void
try {
// render the mermaid diagram to svg text, and parse it to a DOM node
const {svg: svgText, bindFunctions} = await mermaid.render('mermaid', source, parentContainer);
const svgDoc = parseDom(svgText, 'image/svg+xml');
const svgNode = (svgDoc.documentElement as unknown) as SVGSVGElement;
const svgNode = createElementFromHTML<SVGSVGElement>(svgText);

const viewControllerHtml = html`
<div class="view-controller auto-hide-control flex-text-block">
Expand Down
2 changes: 1 addition & 1 deletion web_src/js/utils/dom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ export function isElemVisible(el: HTMLElement): boolean {
return Boolean(!el.classList.contains('tw-hidden') && (el.offsetWidth || el.offsetHeight || el.getClientRects().length) && el.style.display !== 'none');
}

export function createElementFromHTML<T extends HTMLElement>(htmlString: string): T {
export function createElementFromHTML<T extends Element>(htmlString: string): T {
htmlString = htmlString.trim();
// There is no way to create some elements without a proper parent, jQuery's approach: https://github.com/jquery/jquery/blob/main/src/manipulation/wrapMap.js
// eslint-disable-next-line github/unescaped-html-literal
Expand Down
Loading