📌

【React/TypeScript】Dialogタグを使ってコンポーネントを作ってみる ver.2022.09

2022/09/26に公開約8,700字

はじめに

Modal/Dialog は実際のプロジェクトでもよく使うと思います。
有名な React UI ライブラリのChakra UImui にも含まれており大変便利なのですが、
プロジェクト途中からこういったライブラリを導入するのはハードルが非常に高くなってしまいます。
一方、もし自作する場合、普段何気なく使っている Modal/Dialog にも考慮しないといけない仕様も多くわりと大変です。
今回は、自分の中での整理/知識のアップデートもかねて、Dialog を作ってみようと思います。

実装に入る前に

今回ポイントとなる情報を整理します。

Dialog タグ

https://developer.mozilla.org/ja/docs/Web/HTML/Element/dialog

少し前に追加されたタグで、最近 Safari が対応したことで主なモダンブラウザ全般で利用できるようになりました。

https://caniuse.com/dialog

表示/非表示を切り替える showModal / close メソッド、表示状態を表すopen 属性、Overlay を表現するためのbackdrop 疑似要素など、Dialog を作るうえであると便利な機能が備わっているタグです。

また z-index の影響を影響うけない top-layer というところに描画されるため、後ろのコンテンツの z-index が高くても問題ありません。

Focus Trap

TabShift + Tabでフォーカスを移動した際、Dialog の後ろのコンテンツにフォーカスが移動しないようにフォーカス移動を制御する必要があります。
有名なのは以下のライブラリですが、Dialog タグを使うとブラウザが標準でFocus Trapを行ってくれるようなので、今回はライブラリは使いません。
※ サポートブラウザの関係で Dialog タグが利用できない場合は、以下のライブラリ(または類似のライブラリ)を導入する必要があります。

https://github.com/focus-trap/focus-trap

スクロールの連鎖

https://coliss.com/articles/build-websites/operation/css/prevent-scroll-chaining-overscroll-behavior.html

上記の記事からの引用となりますが、

スクロールの連鎖(スクロールチェーン)とは、ページ上にスクロールするコンテンツがあり、そのコンテンツをスクロールして終点に到達するとメインのコンテンツもスクロールしてしまう現象です。

という現象であり、Dialog を実装する上で避けて通れない課題の一つです。

記事中にもあるようにoverscroll-behavior プロパティは非常に有用なのですが、このプロパティを設定した要素にスクロールが発生している状態でないと効きません。
つまり、Dialog の高さが小さい場合は背景がスクロールされてしまいます。

現状、この問題を CSS だけで解決するのは難しいようなので、Chakra UI でも利用されている以下のモジュールを利用します。

https://www.npmjs.com/package/react-remove-scroll

render hooks パターン

@uhyo さんの記事で知った手法です。
カスタムフックでComponentその状態を変更する関数を返すことにより、状態変更時のロジックを隠蔽できるメリットがああります。

https://engineering.linecorp.com/ja/blog/line-securities-frontend-3/

実装

1. Dialog を作る

まず、シンプルに開閉できる Dialog を作ります。

src/Dialog/Dialog.tsx
import { useRef, useEffect } from "react";

import classes from "./Dialog.module.css";

type Props = {
  isOpen: boolean;
  children: React.ReactNode | React.ReactNodeArray;
};

export const Dialog: React.FC<Props> = ({
  isOpen,
  children,
}): React.ReactElement => {
  const dialogRef = useRef<HTMLDialogElement>(null);

  useEffect((): void => {
    const dialogElement = dialogRef.current;
    if (!dialogElement) {
      return;
    }
    if (isOpen) {
      if (dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.showModal();
    } else {
      if (!dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.close();
    }
  }, [isOpen]);

  return (
      <dialog
        className={classes["dialog"]}
        ref={dialogRef}
      >
        <div className={classes["content"]} >
          {children}
        </div>
      </dialog>
  );
};

スタイルは今回はこだわらないので、ほぼほぼデフォルトのままです。

src/Dialog/Dialog.module.css
/**
 * ::backdrop => Dialogの背景(Overlay)の疑似要素
 * :modal     => DialogタグをshowModal()で表示した際の疑似セレクタ
 */

.dialog::backdrop {
  opacity: 0;
  background: rgba(0, 0, 0, 0.5);
}

.dialog:modal::backdrop {
  opacity: 1;
  animation: fadein 0.15s ease-in; /** backdropに表示アニメーションを付与 */
}

@keyframes fadein {
  0% {
    opacity: 0;
  }
  100% {
    opacity: 1;
  }
}

次に、backdrop 部分をクリックした場合、Dialog を閉じるよう修正します。
ただし、疑似要素である ::backdrop はイベントは拾えないため、親の.dialogの onClick を利用します。
※そのままだと dialog の中(.content内)のクリックイベントも伝搬してしまうため、click イベントの伝搬を止める必要があります。

src/Dialog/Dialog.tsx
- import { useRef, useEffect } from "react";
+ import { useCallback, useEffect, useRef } from "react";

import classes from "./Dialog.module.css";

type Props = {
  isOpen: boolean;
  children: React.ReactNode | React.ReactNodeArray;
+  onClose: VoidFunction;
};

export const Dialog: React.FC<Props> = ({
  isOpen,
  children,
+  onClose,
}): React.ReactElement | null => {
  const dialogRef = useRef<HTMLDialogElement>(null);

  useEffect((): void => {
    const dialogElement = dialogRef.current;
    if (!dialogElement) {
      return;
    }
    if (isOpen) {
      if (dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.showModal();
    } else {
      if (!dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.close();
    }
  }, [isOpen]);
+
+  const handleClickDialog = useCallback(
+    (): void => {
+      onClose();
+    },
+    [onClose]
+  );
+
+  const handleClickContent = useCallback(
+    (event: React.MouseEvent<HTMLDivElement>): void => {
+      // clickイベントの伝搬を止める。
+      event.stopPropagation();
+    },
+    []
+  );

  return (
    <dialog
      className={classes["dialog"]}
      ref={dialogRef}
+      onClick={handleClickDialog}
    >
-      <div className={classes["content"]}>
+      <div className={classes["content"]} onClick={handleClickContent}>
        {children}
      </div>
    </dialog>
  );
};

Dialog 内の Padding を.content 内に移します。
※そのままだと、余白部分が.dialog のクリック判定になってしまい、Dialog が閉じてしまいます。

src/Dialog/Dialog.module.css
/**
 * ::backdrop => Dialogの背景(Overlay)の疑似要素
 * :modal     => DialogタグをshowModal()で表示した際の疑似セレクタ
 */

+ .dialog {
+   padding: 0;
+ }

.dialog::backdrop {
  opacity: 0;
  background: rgba(0, 0, 0, 0.5);
}

.dialog:modal::backdrop {
  opacity: 1;
  animation: fadein 0.15s ease-in; /** backdropに表示アニメーションを付与 */
}

@keyframes fadein {
  0% {
    opacity: 0;
  }
  100% {
    opacity: 1;
  }
}

+ .content {
+   padding: 1em;
+ }

最後に、スクロールが連鎖しないように、修正します。

src/Dialog/Dialog.tsx
import { useCallback, useEffect, useRef } from "react";
+ import { RemoveScroll } from "react-remove-scroll";

import classes from "./Dialog.module.css";

type Props = {
  isOpen: boolean;
  children: React.ReactNode | React.ReactNodeArray;
 onClose: VoidFunction;
};

export const Dialog: React.FC<Props> = ({
  isOpen,
  children,
 onClose,
}): React.ReactElement | null => {
  const dialogRef = useRef<HTMLDialogElement>(null);

  useEffect((): void => {
    const dialogElement = dialogRef.current;
    if (!dialogElement) {
      return;
    }
    if (isOpen) {
      if (dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.showModal();
    } else {
      if (!dialogElement.hasAttribute("open")) {
        return;
      }
      dialogElement.close();
    }
  }, [isOpen]);

  const handleClickDialog = useCallback(
   (): void => {
      onClose();
    },
    [onClose]
  );

  const handleClickContent = useCallback(
    (event: React.MouseEvent<HTMLDivElement>): void => {
      // clickイベントの伝搬を止める。
      event.stopPropagation();
    },
    []
  );

  return (
+     <RemoveScroll removeScrollBar enabled={isOpen}>
      <dialog
        className={classes["dialog"]}
        ref={dialogRef}
       onClick={handleClickDialog}
      >
       <div className={classes["content"]} onClick={handleClickContent}>
          {children}
        </div>
      </dialog>
+     </RemoveScroll>
  );
};

2. Dialog を render hook でラップする

特別なことは不要で、通常の render hooks を作ります。

src/Dialog/useDialog.tsx
import { useCallback, useState } from "react";

import { Dialog as Component } from "./Dialog";

type Props = Omit<
  Parameters<typeof Component>[0],
  "isOpen" | "onClose" | "rootElement"
>;

type Result = {
  open: VoidFunction;
  close: VoidFunction;
  Dialog: React.FC<Props>;
};

export const useDialog = (): Result => {
  const [isOpen, setOpen] = useState<boolean>(false);

  const open: VoidFunction = useCallback((): void => {
    setOpen(true);
  }, []);

  const close: VoidFunction = useCallback((): void => {
    setOpen(false);
  }, []);

  const Dialog: React.FC<Props> = useCallback(
    (props: Props): React.ReactElement => {
      return <Component isOpen={isOpen} onClose={close} {...props} />;
    },
    [close, isOpen]
  );

  return { open, close, Dialog };
};

ついでにエントリポイントも作っておきます。

src/Dialog/index.ts
export * from "./useDialog";

以上で実装は完了です。

利用方法

利用する際は以下のように render hooks 経由で呼び出します。

import { useDialog } from "./Dialog";

export const Demo:React.FC => ():React.ReactElement {
  const { Dialog, open: openDialog, close: closeDialog } = useDialog();

  return (
    <section>
      <button type="button" onClick={openDialog}>
        open dialog
      </button>
      <Dialog>
        <header>
          <h2>タイトル</h2>
        </header>
        <section>コンテンツ</section>
        <footer>
          <button type="button" onClick={closeDialog}>
            close
          </button>
        </footer>
      </Dialog>
    </section>
  );
}

完成したもの

実際に動かせるサンプルは以下に置いてあります。

https://codesandbox.io/s/qlh047?file=/src/Dialog/index.ts

TODO

気が向いたときに追記したいと思っています。

GitHubで編集を提案

Discussion

ログインするとコメントできます