Reactで、モーダルをブラウザの「戻る」で閉じる方法

​​React​dialog,History API,Playwright,TypeScript,モーダル

モーダルを開くときに history.pushState() で履歴を1つ積んでおくと、ブラウザの「戻る」でモーダルだけを閉じられます。履歴を使わずに useState だけで開け閉めしていると、「戻る」でページごと前の画面へ移ってしまいます。写真の拡大表示や絞り込みのパネルのように、ブラウザの「戻る」でモーダルだけを閉じたい場面で使えます。

ただし、閉じるボタンや Esc キーで閉じたときにも、積んだ履歴を戻しておく必要があります。検証環境では、戻しておかないと次の「戻る」で画面が何も変わりませんでした。また、閉じるときに history.back() を呼ぶだけだと、「閉じる」をダブルクリックしたときに、モーダルを閉じるだけでなく前のページまで戻ってしまいました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。使ったのは react / react-dom 19.3.1、@types/react 19.3.0、typescript 7.0.2、esbuild 0.28.2 です。.tsx を tsc で型チェックしてから esbuild で変換し、Chromium 153 を Playwright 1.63.0 で操作して確かめました。ブラウザの「戻る」「進む」は、Playwright の page.goBack() と page.goForward() で操作しています。アプリは StrictMode で包み、React の開発用のビルドで動かしました。Chromium 以外のブラウザ、スマホの実機の戻るボタンやジェスチャー、React Router などのルーティングのライブラリと組み合わせた場合は試していません。なお、MDN の cancel イベントのページには、モバイルの戻るボタンが <dialog> を閉じる要求になる場合があると書かれています。

useState だけだと「戻る」でページを離れる

比較のために、まず useState だけで開け閉めする版で試しました。前のページのリンクから写真の一覧へ移り、モーダルを開いてから、ブラウザの「戻る」を押した結果です。page はページのタイトル、dialogOpen は <dialog> が開いているかどうか、state は history.state です。

text
「写真を大きく見る」を押したあと: {"page":"写真の一覧","dialogOpen":true,"state":null}
ブラウザの「戻る」1回目のあと: {"page":"前のページ","dialogOpen":null,"state":null}

出力から、一覧を開いた直後の行と、履歴の数(history.length)の項目を省きました。モーダルを開いても履歴は増えないので、「戻る」は写真の一覧の1つ前、つまり前のページへの移動になりました。

開くときに pushState で履歴を積み、popstate で閉じるフック

そこで、モーダルを開くときに履歴を1つ積みます。検証に使ったフック useHistoryModal の全体です。

ts
import { useCallback, useEffect, useRef, useState } from 'react';

type ModalHistoryState = { modal?: string } | null;

const currentModal = () => (history.state as ModalHistoryState)?.modal;

export function useHistoryModal(key: string) {
  // 再読み込みしたときは、今の履歴の項目にモーダルの記録があれば開いた状態から始める
  const [open, setOpen] = useState(() => currentModal() === key);
  // history.back() を呼んでから popstate が届くまでのあいだ true にしておく
  const closingRef = useRef(false);

  // 「戻る」「進む」で履歴の項目が変わったら、その項目の記録に合わせる
  useEffect(() => {
    const onPopState = () => {
      closingRef.current = false;
      setOpen(currentModal() === key);
    };
    window.addEventListener('popstate', onPopState);
    return () => window.removeEventListener('popstate', onPopState);
  }, [key]);

  const show = useCallback(() => {
    if (currentModal() !== key) {
      // 今の history.state にある値は残したまま、modal を足す
      history.pushState({ ...history.state, modal: key }, '');
    }
    setOpen(true);
  }, [key]);

  const close = useCallback(() => {
    if (currentModal() === key) {
      if (closingRef.current) return; // 続けて押されても、戻るのは1回だけ
      closingRef.current = true;
      history.back(); // popstate が起きて、そこで open が false になる
    } else {
      setOpen(false);
    }
  }, [key]);

  return { open, show, close };
}

show では、pushState() の1つ目の引数に { modal: 'photo' } のような値を渡して、履歴の項目に「モーダルを開いている」という記録を持たせます。2つ目の引数は今は使われていませんが、省けません。MDN の pushState() のページには、空の文字列を渡しておけば将来の変更にも安全だと書かれています。3つ目の URL は省きました。省くと今のページの URL になるので、アドレスバーの表示は変わりません。

「戻る」や「進む」で履歴の項目が切り替わると、window で popstate イベントが起きます(MDN の popstate イベントのページ)。このフックは、そのとき history.state を読み、modal が自分のキーかどうかで open を決めます。開くか閉じるかを、履歴の項目の記録だけで決めるのが要点です。

モーダルの側は、私の「ReactでHTMLのdialog要素を使い、モーダルを作る方法」と同じく、open に合わせて <dialog> の showModal() と close() を呼びます。閉じるボタンと、<dialog> の onClose の両方に、フックの close を渡しました。

tsx
import { useEffect, useRef } from 'react';

type Props = { open: boolean; onClose: () => void; title: string };

export function PhotoDialog({ open, onClose, title }: Props) {
  const ref = useRef<HTMLDialogElement>(null);

  // open に合わせて、dialog をモーダルで開く・閉じる
  useEffect(() => {
    const dialog = ref.current;
    if (!dialog) return;
    if (open && !dialog.open) dialog.showModal();
    if (!open && dialog.open) dialog.close();
  }, [open]);

  return (
    // Esc キーで閉じたときも close イベントが起きるので、onClose に任せる
    <dialog ref={ref} onClose={onClose} aria-label={title}>
      <h2>{title}</h2>
      <p>ブラウザの「戻る」でも閉じられます。</p>
      <button type="button" onClick={onClose}>閉じる</button>
    </dialog>
  );
}

使う側では、useHistoryModal('photo') が返す open・show・close を、ボタンとモーダルに渡します。

tsx
function Gallery() {
  const { open, show, close } = useHistoryModal('photo');
  return (
    <main>
      <h1>写真の一覧</h1>
      <button type="button" className="open" onClick={show}>写真を大きく見る</button>
      <PhotoDialog open={open} onClose={close} title="写真の詳細" />
    </main>
  );
}

検証に使ったコードから、比較用の版を選ぶ処理と、history.state を画面に出す処理を省いています。

「戻る」で閉じ、「進む」でまた開く

このフックで、モーダルを開いてから「戻る」「進む」を押した結果です。出力から、一覧を開いた直後の行と、履歴の数の項目を省きました。

text
「写真を大きく見る」を押したあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
ブラウザの「戻る」1回目のあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
ブラウザの「進む」のあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
もう一度「戻る」のあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
さらに「戻る」のあと: {"page":"前のページ","dialogOpen":null,"state":null}

1回目の「戻る」では、写真の一覧のままモーダルだけが閉じました。history.state は、積む前の null に戻っています。「進む」を押すと {"modal":"photo"} の項目に戻るので、モーダルがまた開きました。さらに「戻る」を2回押すと、モーダルが閉じてから前のページへ移りました。前のページには <dialog> がないので、dialogOpen は null です。

写真の一覧で「写真を大きく見る」を押すとモーダルが開き、下の帯の history.state が {"modal":"photo"} になる。ブラウザの「戻る」でモーダルが閉じて null に戻る。もう一度開いて「閉じる」を押しても、null に戻る
「写真を大きく見る」→ ブラウザの「戻る」→「写真を大きく見る」→「閉じる」と4回操作したときの、モーダルと history.state の動き

GIF の下の帯は、それぞれの操作のあとに読んだ history.state です。ブラウザの「戻る」は Playwright の page.goBack() で操作したので、ブラウザのツールバーは写っていません。押した瞬間を、上の帯の右に「← 戻る」と出して示しています。

閉じるボタンと Esc キーでも history.back() を呼ぶ

閉じるボタンで閉じたときに setOpen(false) だけを呼ぶと、積んだ履歴の項目はそのまま残ります。比較用の版で試しました。

text
「写真を大きく見る」を押したあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
「閉じる」を押したあと: {"page":"写真の一覧","dialogOpen":false,"state":{"modal":"photo"}}
ブラウザの「戻る」1回目のあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
ブラウザの「戻る」2回目のあと: {"page":"前のページ","dialogOpen":null,"state":null}

閉じたあとも history.state は {"modal":"photo"} のままでした。そのため1回目の「戻る」は、残った項目から1つ前に戻るだけで、画面は何も変わりませんでした。前のページへ戻るには、「戻る」を2回押す必要がありました。

記事のフックの close は、今の項目にモーダルの記録があれば、setOpen(false) ではなく history.back() を呼びます。履歴が1つ戻ると popstate が起き、「戻る」を押したときと同じ道筋で open が false になります。同じ操作を記事のフックで行った結果です。

text
「写真を大きく見る」を押したあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
「閉じる」を押したあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
もう一度開いたあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
Esc キーを押したあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
ブラウザの「戻る」1回目のあと: {"page":"前のページ","dialogOpen":null,"state":null}

「閉じる」でも Esc キーでも history.state は null に戻り、次の「戻る」1回で前のページへ移りました。Esc キーで閉じたときは、ブラウザが <dialog> を閉じて close イベントを起こします(MDN の dialog 要素のページ、cancel イベントのページ)。onClose からフックの close が呼ばれるので、閉じるボタンと同じく履歴が1つ戻ります。

popstate で open が false になったあとは、Effect が dialog.close() を呼びます。close() で閉じたときも close イベントが起きるので(MDN の close() のページ)、もう一度 onClose が呼ばれます。このときは今の項目にモーダルの記録がないので、close は setOpen(false) を呼ぶだけで、履歴は戻りません。

なお、記事のフックの出力でも、比較用の版の出力でも、history.length は「戻る」のあとも減らずに、開いたときと同じ数のままでした。このフックでは、履歴の数ではなく history.state でモーダルの状態を判断しています。

ダブルクリックで2回戻らないようにする

history.back() は非同期です。呼んだ時点ではまだ履歴は戻っておらず、終わったことは popstate で分かります(MDN の back() のページ)。そのため、popstate が届く前にもう一度 close が呼ばれると、history.state はまだ {"modal":"photo"} のままで、history.back() が2回呼ばれます。

フックから closingRef の行を外した版と、記事のフックで、「閉じる」をダブルクリックした結果です。出力から、履歴の数の項目を省きました。

text
記事の版:「閉じる」をダブルクリックしたあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
closingRef なしの版:「閉じる」をダブルクリックしたあと: {"page":"前のページ","dialogOpen":null,"state":null}

closingRef のない版では、モーダルが閉じるだけでなく、前のページまで戻ってしまいました。記事のフックは、history.back() を呼んだら closingRef を true にして、popstate が届くまでは2回目を呼ばないようにしています。この値は画面に出さないので、state ではなく ref に入れました(公式リファレンスの useRef のページ)。

開いたまま再読み込みしたとき

pushState() で積んだ項目の記録は、ページを再読み込みしても history.state に残っていました。モーダルを開いたまま再読み込みした結果です。

text
「写真を大きく見る」を押したあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
再読み込みのあと: {"page":"写真の一覧","dialogOpen":true,"state":{"modal":"photo"}}
「閉じる」を押したあと: {"page":"写真の一覧","dialogOpen":false,"state":null}
ブラウザの「戻る」1回目のあと: {"page":"前のページ","dialogOpen":null,"state":null}

フックは useState の初期値を関数で渡し、最初のレンダーで history.state を読んでいます(公式リファレンスの useState のページ)。再読み込みしたあともモーダルは開いた状態で始まり、「閉じる」を押すと履歴が1つ戻って、次の「戻る」1回で前のページへ移りました。

ポイント

開くときに pushState() で履歴を積み、閉じるときはどの閉じ方でも history.back() で戻します。開け閉めは popstate で history.state を見て決め、history.back() を続けて呼ばないようにしておくと、「戻る」の回数とモーダルの状態がずれませんでした。

この記事では URL を変えずに、history.state だけでモーダルの状態を持たせました。pushState() の3つ目の引数に URL を渡すと、積んだ履歴の項目はその URL になります(MDN の pushState() のページ)。URL から値を取り出して画面を切り替える書き方は、私の「ReactとURLPatternでURLから値を取り出す方法」で試しています。

​Posted by 86