ReactでMermaidの文章から図を描いて表示する方法

​​2026年11月14日​React​Mermaid,SVG,TypeScript

Mermaid の記法で書いた文章(flowchart LR で始まるフローチャートなど)を図にするには、mermaid パッケージの mermaid.render() に文章を渡し、返ってきた SVG の文字列を画面に入れます。React では useEffect の中で呼び、結果を state に入れて表示します。

そのためのコンポーネントを TypeScript で作り、描くたびに id を変える理由、書き間違いがあるときの表示、入力中に描き直しすぎない方法、securityLevel の違いを、ブラウザで動かして確かめました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、Chromium 153 です。使ったのは mermaid 12.3.0、react / react-dom 19.3.1、typescript 7.0.2、esbuild 0.28.2、Playwright 1.63.0 です。.tsx を tsc で型チェックしてから esbuild で変換し、開発用ビルドで動かしました(読み込む JS の大きさと中身は、本番用ビルドでも確かめました)。試した図はフローチャートとシーケンス図だけで、Firefox と Safari、スマートフォンのブラウザ、サーバーでの描画(SSR)は試していません。

「Mermaid の文章」の入力欄に flowchart LR で始まる4行の文章があり、その下の水色の枠に「記事を書く」「レビュー」「公開」の3つの箱と、「直す」「OK」の矢印の図が描かれている
入力欄の文章から描いた図(表示の幅375px)

mermaid を入れて、必要になったときに読み込む

bash
npm install mermaid

mermaid は大きなライブラリなので、図を描くときに import() で読み込みます。設定の initialize() も、読み込んだときに1回だけ呼びます。

ts
// loadMermaid.ts
import type { Mermaid } from 'mermaid';

let loading: Promise<Mermaid> | null = null;

export function loadMermaid(): Promise<Mermaid> {
  loading ??= import('mermaid').then(({ default: mermaid }) => {
    mermaid.initialize({
      startOnLoad: false,
      securityLevel: 'strict',
      suppressErrorRendering: true,
      theme: 'neutral',
    });
    return mermaid;
  });
  return loading;
}

startOnLoad: false は、ページの読み込み後に class="mermaid" の要素を自動で探して描く動き(mermaid.run())を止める設定です(公式ドキュメントの mermaid.run の説明)。React では描く場所も時機もコンポーネントで決めるので、止めておきます。suppressErrorRendering は、後の「書き間違いがあるとき」の節で説明します。theme には、白黒の印刷に向いた neutral を選びました(テーマの一覧)。

本番用ビルド(minify あり)で読み込まれる JS を測ると、最初に読む main.js は 224,532 バイトでした。main.js には mermaid のエラー文(Syntax error in text)が含まれず、mermaid.core-….js のファイル名が書かれていました。mermaid の本体は、この別のファイルに入っています。フローチャートを描くときには、追加で 30 個のファイル、合わせて 2,322,796 バイトを読み込みました。esbuild がビルドで分けたファイルは全部で 109 個、5,485,245 バイトです。名前の付いたファイルのうち、読み込んだのは mermaid.core、flowDiagram、elk の3つで、sequenceDiagram など、ほかの図の名前のファイルは読み込みませんでした。

文章を受け取って図を描くコンポーネント

tsx
// MermaidDiagram.tsx
import { useEffect, useId, useRef, useState } from 'react';
import { loadMermaid } from './loadMermaid';

type Props = { code: string };

export function MermaidDiagram({ code }: Props) {
  const baseId = useId();
  const count = useRef(0);
  const [svg, setSvg] = useState('');
  const [error, setError] = useState('');

  useEffect(() => {
    let ignore = false;
    count.current += 1;
    const id = `mermaid${baseId}${count.current}`;

    loadMermaid()
      .then((mermaid) => mermaid.render(id, code))
      .then((result) => {
        if (ignore) return;
        setSvg(result.svg);
        setError('');
      })
      .catch((e: unknown) => {
        if (ignore) return;
        setError(e instanceof Error ? e.message : String(e));
      });

    return () => {
      ignore = true;
    };
  }, [code, baseId]);

  return (
    <figure className="diagram">
      {svg ? (
        <div dangerouslySetInnerHTML={{ __html: svg }} />
      ) : (
        !error && <p className="loading">図を描いています…</p>
      )}
      {error && <pre className="error">{error}</pre>}
    </figure>
  );
}

mermaid.render(id, 文章) は、SVG の文字列を svg に持つオブジェクトを返す Promise です(公式ドキュメントの API の使い方)。返ってきた svg の文字列を dangerouslySetInnerHTML で入れます。描き終わる前は「図を描いています…」と出します。

code が変わると、前の effect のクリーンアップで ignore が true になり、古い文章から描いた結果は state に入りません。React の公式ドキュメントにある、effect でデータを取得するときの競合への対処と同じ書き方です。

描くたびに違う id を渡す

render() の1つ目の引数は、できあがる <svg> の id になります。検証環境で描いた図は id="mermaid_r_0_2" で、SVG の中の <style> は #mermaid_r_0_2{font-family:… のように、この id で始まっていました。StrictMode を使わない検証用のページに図を2つ置くと、id は mermaid_r_0_1 と mermaid_r_1_1 になり、重なりませんでした。

React 19.2 からは、useId が _r_0_ のようにアンダースコアで区切った値を返します(React の CHANGELOG)。React 19.1 より前の useId は :r0: のようにコロンを含む形でした(19.1.0 の項)。この形の id を render() に渡すと、'#d:r0:' is not a valid selector. というエラーになり、図は描けませんでした。

useId の値の後ろに付けている count は、描くたびに id を変えるためのものです。React を通さずに render() を直接呼んで試したところ、表示中の <svg> と同じ id で呼ぶと、描き終わって結果を入れる前に、表示中の <svg> がページから消えていました。違う id で呼んだときは、結果を入れるまで前の図が残っていました。

開発用ビルドの StrictMode では effect が2回実行されるので、最初の図の id は末尾が 2 になります。1回目の結果は、ignore で捨てる書き方にしてあります。描くあいだ mermaid が <body> に一時的に足す要素(id は dmermaid_r_0_1 と dmermaid_r_0_2)は、描き終わると消えていました。

書き間違いがあるときは、エラーを出して前の図を残す

文章に書き間違いがあると、render() の Promise は Error で reject されます。上のコンポーネントでは、エラーのメッセージを <pre> に出し、svg の state はそのままにしているので、前に描けた図が残ります。

入力欄の2行目が「B{レビュー」で閉じかっこがない。下の枠には前に描けた図が残り、その下のピンクの枠に「Parse error on line 3:」で始まるエラーのメッセージが出ている
閉じかっこを消したときの表示。前の図とエラーのメッセージが並ぶ

initialize() に渡している suppressErrorRendering: true は、エラーのときに「Syntax error」の図を DOM に入れないようにする設定です(MermaidConfig の suppressErrorRendering)。

この設定を付けずに、書き間違いのある文章から図を描こうとすると、render() を呼んだ側にはエラーが返るうえに、「Syntax error in text」と書かれた要素が <body> のいちばん最後に残りました。残った要素の id は、render() に渡した id の前に d を付けたものです。

水色の枠のシーケンス図の下、ページのいちばん下に「Syntax error in text」「mermaid version 12.3.0」とエラーのメッセージが大きく出ている
suppressErrorRendering を付けずに書き間違いを描いたあとの、検証用ページ(フローチャートとシーケンス図を並べたページ)のいちばん下

設定を付けたときは、エラーが返るだけで、<body> に余分な要素は残りませんでした。

描かずに書き方だけを確かめたいときは、mermaid.parse() を使えます。正しい文章では { diagramType: 'flowchart-v2', … } が返り、書き間違いのある文章に { suppressErrors: true } を付けて渡すと、例外ではなく false が返りました(公式ドキュメントの parse の説明)。

入力欄の文章は、打ち終わるのを待ってから描く

入力欄の文章を待たずにそのまま渡すと、1文字打つたびに render() が呼ばれます。下の App の待ち時間を 0 にして、検証環境で 30 ミリ秒おきに 17 文字を打ったところ、render() も 17 回呼ばれました。render() は複数回呼ぶと順番待ちになって1つずつ実行されます(mermaid のソース(mermaid.ts)にある render() の説明)。

そこで、入力が 300 ミリ秒止まってから値を渡すフックを挟みました。

ts
// useDebouncedValue.ts
import { useEffect, useState } from 'react';

export function useDebouncedValue<T>(value: T, delay: number): T {
  const [debounced, setDebounced] = useState(value);

  useEffect(() => {
    const timer = setTimeout(() => setDebounced(value), delay);
    return () => clearTimeout(timer);
  }, [value, delay]);

  return debounced;
}
tsx
// App.tsx
import { useState } from 'react';
import { MermaidDiagram } from './MermaidDiagram';
import { useDebouncedValue } from './useDebouncedValue';

const initial = `flowchart LR
  A[記事を書く] --> B{レビュー}
  B -->|直す| A
  B -->|OK| C[公開]`;

export function App({ delay = 300 }: { delay?: number }) {
  const [code, setCode] = useState(initial);
  const debouncedCode = useDebouncedValue(code, delay);

  return (
    <main>
      <label htmlFor="src">Mermaid の文章</label>
      <textarea
        id="src"
        value={code}
        onChange={(e) => setCode(e.target.value)}
        rows={6}
        spellCheck={false}
      />
      <MermaidDiagram code={debouncedCode} />
    </main>
  );
}

同じように 17 文字を打つと、render() は1回だけ呼ばれ、打ち終わった文章の図(最後に足した「説明を足す」の箱を含む図)が出ました。

securityLevel で、文章に書いた click を効かせるかを決める

Mermaid の文章には、click A call alert("clicked") のように、図の箱を押したときにページの関数を呼ぶ指定を書けます(フローチャートの書き方にある Interaction の節)。これが効くかどうかは securityLevel で決まり、初期値は strict です(公式ドキュメントの securityLevel の説明)。

click の指定を効かせるには、render() が返すオブジェクトにある bindFunctions を、SVG を DOM に入れたあとで呼びます(公式ドキュメントの、イベントを付ける例)。上の MermaidDiagram は svg しか使っていないので、click の指定は効きません。

検証環境では、上の click の指定を含む図を render() で描いて要素に入れ、bindFunctions を呼んでから箱を押して比べました。strict では何も起きず、loose では alert のダイアログが開きました。

公式ドキュメントでは、strict ではラベルの中の HTML のタグを文字としてエンコードすると説明されています。ただ、検証環境の 12.3.0 では、ラベルに書いた <b> と <img> は strict でも要素のまま残り、<img> に付けた onerror の属性は取り除かれていました。loose でも onerror は取り除かれ、書いておいた処理は実行されませんでした。

注意

securityLevel を loose にすると、文章に書いた click の指定で、ページの関数が呼ばれます。読者やユーザーが書いた文章を図にするページでは、strict のままにしておきます。

​Posted by 86