Skip to content

Commit

Permalink
Fix mermaid diagram height when initially hidden (#32457)
Browse files Browse the repository at this point in the history
In a hidden iframe, `document.body.clientHeight` is not reliable. Use
`IntersectionObserver` to detect the visibility change and update the
height there.

Fixes: #32392

<img width="885" alt="image"
src="https://github.com/user-attachments/assets/a95ef6aa-27e7-443f-9d06-400ef27919ae">
  • Loading branch information
silverwind authored Nov 9, 2024
1 parent 18aeca5 commit b55a31e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion web_src/js/markup/mermaid.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,21 @@ export async function renderMermaid() {
btn.setAttribute('data-clipboard-text', source);
mermaidBlock.append(btn);

const updateIframeHeight = () => {
iframe.style.height = `${iframe.contentWindow.document.body.clientHeight}px`;
};

// update height when element's visibility state changes, for example when the diagram is inside
// a <details> + <summary> block and the <details> block becomes visible upon user interaction, it
// would initially set a incorrect height and the correct height is set during this callback.
(new IntersectionObserver(() => {
updateIframeHeight();
}, {root: document.documentElement})).observe(iframe);

iframe.addEventListener('load', () => {
pre.replaceWith(mermaidBlock);
mermaidBlock.classList.remove('tw-hidden');
iframe.style.height = `${iframe.contentWindow.document.body.clientHeight}px`;
updateIframeHeight();
setTimeout(() => { // avoid flash of iframe background
mermaidBlock.classList.remove('is-loading');
iframe.classList.remove('tw-invisible');
Expand Down

0 comments on commit b55a31e

Please sign in to comment.