Reactで確認ダイアログをawaitで待てるフックにする方法

​​React​dialog,Playwright,Promise,TypeScript,モーダル

「削除しますか?」のような確認ダイアログを、window.confirm と同じ感覚で if (await confirm(...)) と書けるフック useConfirm にします。見た目は HTML の <dialog> 要素で自由に作れて、押したボタンの結果は true / false の Promise で受け取れます。ファイルやデータの削除、入力中の画面からの移動など、操作の前に一度確かめたい場面で使えます。

この形で気をつけるのは、作った Promise を必ず終わらせることです。検証環境では、Promise を終わらせる処理を入れないと、別の確認が割り込んだときは1つ目の確認の続きが動きませんでした。ダイアログを開いたまま画面が切り替わったときは、約4秒待っても await の先が動きませんでした。

補足

検証環境は 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 で操作して確かめました。アプリは StrictMode で包み、React の開発用のビルドで動かしています。Chromium 以外のブラウザ、スクリーンリーダーでの読み上げ、本番用のビルドでは試していません。

使う側は await で結果を受け取る

先に、使う側のコードです。useConfirm() が返す confirm に、タイトルと本文を渡します。ダイアログが閉じると、「削除する」なら true、それ以外なら false が返ります。

tsx
function FileList() {
  const confirm = useConfirm();
  const [files, setFiles] = useState(['report.pdf', 'photo.png', 'memo.txt']);

  async function handleDelete(name: string) {
    const ok = await confirm({
      title: `${name} を削除しますか?`,
      message: '削除したファイルは元に戻せません。',
      okLabel: '削除する',
    });
    if (!ok) return;
    setFiles((fs) => fs.filter((f) => f !== name));
  }
  // …
}

検証に使ったコードから、結果を記録する行と、あとの節で使うフォーカスの処理を省いています。useConfirm を使うコンポーネントは、あとで作る ConfirmProvider の中に置きます。

tsx
<ConfirmProvider>
  <FileList />
</ConfirmProvider>

ブラウザ組み込みの window.confirm() も、OK なら true、キャンセルなら false を返します(MDN の window.confirm() のページ)。違うのは、そのあいだ JavaScript が止まることです。検証環境で、50ms ごとに動くタイマーの間隔を測りながら、それぞれのダイアログを1秒開いてから OK を押しました。出力から、各行の後ろに付けた confirm の結果の記録を省いて抜き出しています。

text
window.confirm(1秒開いて OK): タイマーの間隔の最大 1040ms
useConfirm(1秒開いて「削除する」): タイマーの間隔の最大 51ms

window.confirm() を開いているあいだは、タイマーが約1秒止まりました。useConfirm では、ダイアログを開いていても、間隔は最大 51ms で、タイマーはほぼ 50ms ごとに動き続けました。MDN の同じページの注記も、確認には <dialog> 要素を使う方法を挙げています。

ConfirmProvider と useConfirm の全体

検証に使ったコードの全体です。ConfirmProvider が <dialog> を1つだけ持ち、confirm を Context で配ります。

tsx
import {
  createContext, useCallback, useContext, useEffect, useId, useRef, useState,
  type ReactNode,
} from 'react';

export type ConfirmOptions = {
  title: string;
  message: string;
  okLabel?: string;
  cancelLabel?: string;
};
type ConfirmFn = (options: ConfirmOptions) => Promise<boolean>;

const ConfirmContext = createContext<ConfirmFn | null>(null);

export function useConfirm(): ConfirmFn {
  const confirm = useContext(ConfirmContext);
  if (!confirm) throw new Error('useConfirm は ConfirmProvider の中で使ってください');
  return confirm;
}

export function ConfirmProvider({ children }: { children: ReactNode }) {
  const [options, setOptions] = useState<ConfirmOptions | null>(null);
  // 待っている Promise の resolve を、再レンダーをまたいで持っておく
  const resolveRef = useRef<((ok: boolean) => void) | null>(null);
  const dialogRef = useRef<HTMLDialogElement>(null);
  const titleId = useId();

  const settle = (ok: boolean) => {
    resolveRef.current?.(ok);
    resolveRef.current = null;
  };

  const confirm = useCallback<ConfirmFn>((opts) => {
    settle(false); // 前の確認がまだ開いていたら、false で終わらせる
    setOptions(opts);
    return new Promise<boolean>((resolve) => {
      resolveRef.current = resolve;
    });
  }, []);

  // options が入ったら、dialog をモーダルで開く
  useEffect(() => {
    const dialog = dialogRef.current;
    if (options && dialog && !dialog.open) {
      dialog.returnValue = '';
      dialog.showModal();
    }
  }, [options]);

  // Provider が画面から消えるときも、待っている Promise を終わらせる
  useEffect(() => () => settle(false), []);

  return (
    <ConfirmContext value={confirm}>
      {children}
      <dialog
        ref={dialogRef}
        aria-labelledby={titleId}
        // ボタンでも Esc キーでも、閉じたら呼ばれる
        onClose={(e) => {
          settle(e.currentTarget.returnValue === 'ok');
          setOptions(null);
        }}
      >
        {options && (
          <form method="dialog">
            <h2 id={titleId}>{options.title}</h2>
            <p>{options.message}</p>
            <div className="actions">
              <button value="cancel">{options.cancelLabel ?? 'キャンセル'}</button>
              <button value="ok" className="ok">{options.okLabel ?? 'OK'}</button>
            </div>
          </form>
        )}
      </dialog>
    </ConfirmContext>
  );
}

要になるのは、confirm の中で作った Promise の resolve を resolveRef にしまっておき、ダイアログが閉じたときに呼ぶことです。resolve は画面に出す値ではないので、state ではなく ref に入れます。公式リファレンスの useRef のページのとおり、ref は再レンダーをまたいで値を持ち、書き換えても再レンダーは起きません。

<ConfirmContext value={confirm}> の書き方は、React 19 からのものです。それより前の React では <ConfirmContext.Provider> と書きます(公式リファレンスの createContext のページ)。confirm は useCallback で作っています。公式リファレンスの useCallback のページのとおり、依存配列の値が変わらないあいだは同じ関数が返るので、使う側の Effect の依存配列に入れても、レンダーのたびに変わることはありません。なお、useCallback の中で使っている settle は依存配列に入れていません。型を外したこのコードを eslint-plugin-react-hooks 7.1.1 の exhaustive-deps で調べたところ、警告は出ませんでした。

どのボタンで閉じたかを returnValue で受け取る

ボタンは method="dialog" の <form> に入れています。このフォームのボタンを押すとダイアログが閉じて、押したボタンの value が <dialog> の returnValue に入ります(MDN の dialog 要素のページの補足)。onClose で returnValue が ok かどうかを見れば、resolve に渡す値が決まります。

Esc キーで閉じたときは returnValue が設定されません(MDN の returnValue のページ)。そのため開く前に returnValue を空の文字列に戻しておき、前の「削除する」の ok が残らないようにしています。<dialog> を showModal() で開く書き方や、onClose で React の state を戻す理由は、私の「ReactでHTMLのdialog要素を使い、モーダルを作る方法」の記事で詳しく試しています。

photo.png の「削除」を押してダイアログを開き、「キャンセル」、Esc キー、「削除する」の順に、開いては閉じた結果です(focus はフォーカスのある要素、logs は confirm の結果を記録したものです)。

text
photo.png の「削除」を押したあと: {"dialogOpen":true,"title":"photo.png を削除しますか?","focus":"button「キャンセル」","list":"ファイル(3件)","logs":[]}
「キャンセル」を押したあと: {"dialogOpen":false,"focus":"button「削除」","list":"ファイル(3件)","logs":["confirm の結果(photo.png): false"]}
もう一度開いて Esc キーを押したあと: {"dialogOpen":false,"focus":"button「削除」","list":"ファイル(3件)","logs":[…,"confirm の結果(photo.png): false"]}
もう一度開いて「削除する」を押したあと: {"dialogOpen":false,"focus":"body","list":"ファイル(2件)","logs":[…,"confirm の結果(photo.png): true"]}

出力から、どちらの版で動かしたかを記録した logs の最初の項目と、毎回同じ項目(dialog と、閉じたあとの title)を省きました。logs の「…」は、前の行までと同じ記録です。「キャンセル」と Esc キーでは false、「削除する」では true が返り、一覧が2件になりました。

ファイルの一覧で photo.png の「削除」を押すと確認ダイアログが開く。「キャンセル」を押すと結果の欄に false と出る。もう一度開いて「削除する」を押すと結果の欄に true と出て、一覧が3件から2件に減る
「削除」→「キャンセル」→「削除」→「削除する」と4回クリックしたときの、ダイアログと confirm の結果の動き

開いた直後のフォーカスは、ダイアログの中で最初に置いた「キャンセル」にありました。MDN の dialog 要素のページのアクセシビリティの節にあるとおり、showModal() で開くと、中の最初のフォーカスできる要素にフォーカスが移ります。取り消せない操作の確認なので、「キャンセル」を先に置いています。

削除した行のボタンからフォーカスが外れる

「キャンセル」や Esc キーで閉じたあとは、フォーカスが元の「削除」ボタンに戻りました。ところが「削除する」で閉じたあとは、フォーカスがどのボタンにもない状態(document.activeElement が body)になりました。「キャンセル」のときと違い、元の「削除」ボタンは行ごと一覧から消えています。元のボタンが消えたときの戻し先は、私の「Reactでモーダルを閉じたあと、元のボタンにフォーカスを戻す方法」の記事でも試しています。

この記事の検証では、一覧の見出しに tabIndex={-1} を付け、削除したあとで見出しにフォーカスを移しました。

tsx
const headingRef = useRef<HTMLHeadingElement>(null);

// handleDelete の中、setFiles のあとで
headingRef.current?.focus();

<h2 ref={headingRef} tabIndex={-1}>ファイル({files.length}件)</h2>

出力から、フォーカスと一覧の見出しの項目だけを抜き出しました。

text
「削除する」を押したあと: {"focus":"h2「ファイル(2件)」","list":"ファイル(2件)"}
続けて Tab キーを押したあと: {"focus":"button「削除」","list":"ファイル(2件)"}

フォーカスは「ファイル(2件)」の見出しに移り、Tab キーで残った行の「削除」ボタンへ進みました。

Promise を終わらせないと await の先が動かない

ConfirmProvider の中で settle(false) を呼んでいる箇所が2つあります。この2つを外した版を作り、記事の版と比べました。

1つ目は、確認が開いているところに、別の確認が来たときです。ボタンを押すと1つ目の確認を出し、0.3秒後に2つ目の確認を出すようにしました。

tsx
confirm({ title: '1つ目の確認', message: '保存しますか?' })
  .then((ok) => log(`1つ目の結果: ${ok}`));
setTimeout(() => {
  confirm({ title: '2つ目の確認', message: 'ログアウトしますか?' })
    .then((ok) => log(`2つ目の結果: ${ok}`));
}, 300);

2つ目の確認で「OK」を押したあとの logs を、2つの版で並べて抜き出しました(どちらの版で動かしたかを記録した最初の項目は省いています)。

text
記事の版:          ["1つ目の結果: false","2つ目の結果: true"]
settle を外した版: ["2つ目の結果: true"]

記事の版では、2つ目が来た時点で1つ目が false で終わりました。外した版では、2つ目が resolveRef を上書きしたため、1つ目の Promise はどこからも resolve されず、.then が呼ばれませんでした。ダイアログは1つなので、2つ目の内容に入れ替わって開いたままでした。

2つ目は、ダイアログを開いたまま ConfirmProvider ごと画面から消えるときです。ボタンを押して確認を出し、0.3秒後に別の画面へ切り替えました。

tsx
setTimeout(onLeave, 300); // 開いている途中で、画面ごと切り替わる
try {
  const ok = await confirm({ title: '移動しますか?', message: '入力中の内容は消えます。' });
  log(`切り替え前の確認の結果: ${ok}`);
} finally {
  log('finally に来た');
}

ボタンを押してから約4秒後の logs を、同じように2つの版で並べて抜き出しました。

text
記事の版:          ["切り替え前の確認の結果: false","finally に来た"]
settle を外した版: []

外した版では、await の次の行にも finally にも進みませんでした。finally に後片付けを書いていても、それが実行されないということです。記事の版では、Effect のクリーンアップで settle(false) を呼んでいます。公式リファレンスの useEffect のページのとおり、クリーンアップはコンポーネントが DOM から取り除かれたあとに呼ばれます。

ポイント

confirm が返した Promise は、ボタンや Esc キーで閉じたとき、別の確認が割り込んだとき、Provider が消えるときの、どの場合でも true か false で終わらせます。

StrictMode では、開発中だけ Effect のセットアップとクリーンアップが1回余分に動きます(同じ useEffect のページ)。このときのクリーンアップでは、まだ resolveRef が空なので何も起きません。検証は StrictMode の中で行い、上の結果のとおり動きました。

​Posted by 86