Repository navigation
Use Pele for Mermaid flowcharts #1457
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
Open
benjavicente
wants to merge
1
commit into
TanStack:main
Choose a base branch
from
benjavicente:test-pele-mermaid-rendering
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,142 +1,49 @@ | ||
| import { mount, register } from 'pele/core' | ||
| import flowchart from 'pele/diagrams/flowchart' | ||
| import * as React from 'react' | ||
| import { twMerge } from 'tailwind-merge' | ||
| import { CodeBlockView } from './CodeBlockView' | ||
| import { buildPlainCodeBlockHtml } from './codeBlock.shared' | ||
|
|
||
| // Mermaid shares configuration and a temporary DOM across renders. | ||
| let mermaidRenderQueue = Promise.resolve() | ||
| let mermaidRenderId = 0 | ||
|
|
||
| type MermaidRenderState = | ||
| | { | ||
| status: 'loading' | ||
| svg?: undefined | ||
| } | ||
| | { | ||
| status: 'rendered' | ||
| svg: string | ||
| } | ||
| | { | ||
| status: 'error' | ||
| svg?: undefined | ||
| } | ||
|
|
||
| function getIsDarkMode() { | ||
| return document.documentElement.classList.contains('dark') | ||
| } | ||
|
|
||
| function useIsDarkMode() { | ||
| const [isDark, setIsDark] = React.useState(false) | ||
|
|
||
| React.useEffect(() => { | ||
| const updateIsDark = () => setIsDark(getIsDarkMode()) | ||
| updateIsDark() | ||
|
|
||
| const observer = new MutationObserver(updateIsDark) | ||
| observer.observe(document.documentElement, { | ||
| attributeFilter: ['class'], | ||
| attributes: true, | ||
| }) | ||
|
|
||
| return () => observer.disconnect() | ||
| }, []) | ||
|
|
||
| return isDark | ||
| } | ||
| register(flowchart) | ||
|
|
||
| export function MermaidBlock({ | ||
| className, | ||
| code, | ||
| isEmbedded, | ||
| showTypeCopyButton, | ||
| style, | ||
| title, | ||
| }: { | ||
| className?: string | ||
| code: string | ||
| isEmbedded?: boolean | ||
| showTypeCopyButton?: boolean | ||
| style?: React.CSSProperties | ||
| title?: string | ||
| }) { | ||
| const isDark = useIsDarkMode() | ||
| const [renderState, setRenderState] = React.useState<MermaidRenderState>({ | ||
| status: 'loading', | ||
| }) | ||
|
|
||
| React.useEffect(() => { | ||
| let cancelled = false | ||
|
|
||
| setRenderState({ status: 'loading' }) | ||
|
|
||
| async function renderMermaid() { | ||
| if (cancelled) return | ||
|
|
||
| const container = document.createElement('div') | ||
| container.style.visibility = 'hidden' | ||
| container.style.position = 'absolute' | ||
| document.body.append(container) | ||
|
|
||
| try { | ||
| const mermaid = (await import('mermaid')).default | ||
| if (cancelled) return | ||
|
|
||
| mermaid.initialize({ | ||
| securityLevel: 'strict', | ||
| startOnLoad: false, | ||
| theme: isDark ? 'dark' : 'default', | ||
| }) | ||
|
|
||
| const { svg } = await mermaid.render( | ||
| `mermaid-${++mermaidRenderId}`, | ||
| code, | ||
| container, | ||
| ) | ||
|
|
||
| if (!cancelled) { | ||
| setRenderState({ status: 'rendered', svg }) | ||
| } | ||
| } catch { | ||
| if (!cancelled) { | ||
| setRenderState({ status: 'error' }) | ||
| } | ||
| } finally { | ||
| container.remove() | ||
| const mountDiagram = React.useCallback( | ||
| (container: HTMLDivElement | null) => { | ||
| if (!container) return | ||
|
|
||
| const diagram = mount(container, code, { | ||
| // Keep diagrams from navigating or loading remote images. | ||
| links: false, | ||
| images: false, | ||
| zoom: false, | ||
| }) | ||
|
|
||
| return () => { | ||
| diagram.destroy() | ||
| } | ||
| } | ||
|
|
||
| mermaidRenderQueue = mermaidRenderQueue.then(renderMermaid) | ||
|
|
||
| return () => { | ||
| cancelled = true | ||
| } | ||
| }, [code, isDark]) | ||
|
|
||
| if (renderState.status !== 'rendered') { | ||
| return ( | ||
| <CodeBlockView | ||
| className={className} | ||
| copyText={code.trimEnd()} | ||
| htmlMarkup={buildPlainCodeBlockHtml(code)} | ||
| isEmbedded={isEmbedded} | ||
| lang="mermaid" | ||
| showTypeCopyButton={showTypeCopyButton} | ||
| style={style} | ||
| title={title} | ||
| /> | ||
| ) | ||
| } | ||
| }, | ||
| [code], | ||
| ) | ||
|
|
||
| return ( | ||
| <div | ||
| ref={mountDiagram} | ||
| className={twMerge( | ||
| 'mermaid-block not-prose w-full max-w-full overflow-x-auto rounded-md border border-gray-500/20 bg-white p-4 dark:bg-gray-950 [&_svg]:mx-auto [&_svg]:max-w-none', | ||
| 'mermaid-block not-prose w-full min-w-0 max-w-full overflow-hidden rounded-md border border-gray-500/20 bg-white p-4 dark:bg-gray-950 [&_svg]:mx-auto', | ||
| className, | ||
| )} | ||
| style={style} | ||
| role="img" | ||
| role="group" | ||
| aria-label={title ?? 'Mermaid diagram'} | ||
| dangerouslySetInnerHTML={{ __html: renderState.svg }} | ||
| /> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep the code fallback when the diagram chunk fails to load.
If the dynamic import rejects,
React.lazysends the error to the nearest error boundary.React.Suspensedoes not retainCodeBlockView. A failed chunk request therefore removes the copyable diagram source instead of leaving it available. Handle the import failure at this block and renderCodeBlockViewas the error fallback. (react.dev)