Modal

Modalは、主要なコンテンツに重ねて表示され、ユーザーの注意を情報のみに集中させるコンポーネントです。

使い方

import { Modal } from "@yamada-ui/react"
<Modal.Root>
  <Modal.OpenTrigger />
  <Modal.Overlay />
  <Modal.Content>
    <Modal.CloseButton />
    <Modal.Header>
      <Modal.Title />
    </Modal.Header>
    <Modal.Body />
    <Modal.Footer>
      <Modal.CloseTrigger />
    </Modal.Footer>
  </Modal.Content>
</Modal.Root>

propsを使う

サイズを変更する

位置を変更する

表示位置を変更する場合は、placement"start-center""center-start"などを設定します。デフォルトでは、"center-center"が設定されています。

アニメーションを変更する

表示または非表示のアニメーションを変更する場合は、animation"block-start""inline-end"などを設定します。デフォルトでは、"scale"が設定されています。

所要時間を変更する

所要時間を変更する場合は、durationに数値(秒)を設定します。

オーバーフローの動作を変更する

デフォルトでは、"inside"が設定されており、スクロールはModal.Body内でのみ発生します。"outside"を設定すると、Modal.Content内でスクロールが発生します。

モーダルを開いたときにスクロールをブロックしない

デフォルトでは、モーダルを開いた際に主要なコンテンツのスクロールをブロックしています。これは、アクセシビリティを確保するためです。もし、主要なコンテンツのスクロールをブロックしたくない場合は、blockScrollOnMountfalseに設定します。

オーバーレイをカスタマイズする

オーバーレイをカスタマイズする場合は、Modal.Overlayを使用します。

オーバーレイを無効にする

モーダルのオーバーレイを無効(非表示)にする場合は、withOverlayfalseにします。

閉じるボタンをカスタマイズする

閉じるボタンをカスタマイズする場合は、Modal.CloseButtonを使用します。

閉じるボタンを無効にする

モーダルの閉じるボタンを無効(非表示)にする場合は、withCloseButtonfalseにします。

ネストしたモーダル

Props

アクセシビリティ

現在、v2の移行に伴い、このセクションは更新中です。