ドキュメントを検索

Dialog

ユーザーに入力や決定を求めるモーダルウィンドウです。

DialogはDialog (Modal) WAI-ARIAデザインパターンに準拠しています。

Edit profile

Change how your name appears to others.

import { component$, useStyles$ } from '@builder.io/qwik';
import { Dialog } from '@leve-ui/dialog';
import { LuX } from '@qwikest/icons/lucide';
import styles from './default.css?inline';

export default component$(() => {
  useStyles$(styles);

  return (
    <Dialog.Root class="dialog-default">
      <Dialog.Trigger class="dialog-default-trigger">Edit profile</Dialog.Trigger>
      <Dialog.Content class="dialog-default-content">
        <Dialog.Title class="dialog-default-title">Edit profile</Dialog.Title>
        <Dialog.Description class="dialog-default-description">
          Change how your name appears to others.
        </Dialog.Description>
        <label class="dialog-default-label">
          Name
          <input class="dialog-default-input" name="name" value="Ada Lovelace" />
        </label>
        <div class="dialog-default-actions">
          <Dialog.Close class="dialog-default-button">Cancel</Dialog.Close>
          <Dialog.Close class="dialog-default-button dialog-default-button-primary">
            Save
          </Dialog.Close>
        </div>
        <Dialog.Close class="dialog-default-close" aria-label="Close">
          <LuX class="dialog-default-icon" aria-hidden="true" />
        </Dialog.Close>
      </Dialog.Content>
    </Dialog.Root>
  );
});

インストール#

個別のパッケージをインストールするか、@leve-ui/coreを使用してすべてのコンポーネントを一度に取得します。

pnpm add @leve-ui/dialog

構造#

import { Dialog } from '@leve-ui/dialog'; // or '@leve-ui/core'

<Dialog.Root>
  <Dialog.Trigger />
  <Dialog.Content>
    <Dialog.Title />
    <Dialog.Description />
    <Dialog.Close />
  </Dialog.Content>
</Dialog.Root>
パーツ要素説明
Dialog.Root<div>各パーツをラップし、開閉状態を保持します。
Dialog.Trigger<button>ダイアログを開くボタンです。別の要素やコンポーネントをレンダリングするにはasを使用します。
Dialog.Content<dialog>showModal()で開かれるダイアログです。
Dialog.Title<h2>ダイアログの名前を示すタイトルです。
Dialog.Description<p>ダイアログの説明です。
Dialog.Close<button>ダイアログを閉じるボタンです。別の要素やコンポーネントをレンダリングするにはasを使用します。

Dialog.TriggerまたはDialog.Closeのasに渡されるコンポーネントは、id、aria-*、data-*、およびon*$イベントハンドラーを含む受け取ったpropsを単一の要素にスプレッドする必要があります。

Dialog.Contentはネイティブの<dialog>です。配置した場所にレンダリングされ、ブラウザによってトップレイヤーのページ上部に表示されるため、祖先要素のoverflow: hiddenやz-indexによって切り取られることはありません。Overlayパーツはありません。Contentの::backdrop擬似要素でバックドロップのスタイルを設定してください。

[data-leve-dialog-content]::backdrop {
  background: rgb(15 23 42 / 0.5);
}

例#

Controlled#

bind:openはシグナルで開閉状態を制御します。ここでは、保存後にSaveがコードからダイアログを閉じます。

Closed

Rename file

The dialog closes from code after saving.

永続#

closeOnOutsideClick={false}を指定すると、バックドロップがクリックされてもダイアログを開いたままにします。Escapeやボタンでは引き続き閉じることができます。

Delete project?

This deletes the project and its files. You cannot undo it.

APIリファレンス#

Root#

Propデフォルト型
ids–{ trigger?: string; content?: string; title?: string; description?: string }

パーツの要素IDをオーバーライドします。

defaultOpenfalseboolean

初期状態でダイアログを開くかどうか(非制御)。showModal()はクライアントで実行されるため、ページのレジューム時にダイアログが開きます。

bind:open–Signal<boolean>

開閉状態を保持するシグナル(制御)。

onOpenChange$–QRL<(open: boolean) => void>

ユーザー操作によってダイアログが開閉されたときに呼び出されます。

すべての<div>属性も受け入れます。

データ属性値
data-leve-dialog常に存在
data-state"open" | "closed"

開閉状態はdefaultOpenで非制御に、またはbind:openで制御できます。onOpenChange$は、ユーザーがダイアログを開閉したときに呼び出されます。SSR HTMLでは常にダイアログが閉じた状態でレンダリングされます。showModal()はクライアントで実行されるため、初期状態で開いているダイアログはページのレジューム時に開きます。

Trigger#

Propデフォルト型
as'button'keyof HTMLElementTagNameMap | Component<any>

<button>の代わりにレンダリングする要素またはコンポーネントです。コンポーネントは受け取ったpropsを1つの要素にスプレッドする必要があります。

すべての<button>属性も受け入れます。

データ属性値
data-leve-dialog-trigger常に存在
data-state"open" | "closed"

Content#

Propデフォルト型
closeOnEscapetrueboolean

Escapeでダイアログを閉じるかどうか。他の操作を行わずにEscapeを2回押すとブラウザによって閉じられる場合がありますが、状態はそれに追従します。

closeOnOutsideClicktrueboolean

ダイアログの外側(バックドロップ上)でのポインターダウンによってダイアログを閉じるかどうか。

すべての<dialog>属性も受け入れます。

データ属性値
data-leve-dialog-content常に存在
data-state"open" | "closed"

ブラウザはダイアログの表示中にopen属性を追加します。デモのように、[open]と@starting-styleを使用して、ダイアログとその::backdropの表示時にアニメーションを適用します。

タイトル#

独自のpropはありません。 すべての<h2>属性を受け入れます。

データ属性値
data-leve-dialog-title常に存在

説明#

独自のpropはありません。 すべての<p>属性を受け入れます。

データ属性値
data-leve-dialog-description常に存在

閉じる#

Propデフォルト型
as'button'keyof HTMLElementTagNameMap | Component<any>

<button>の代わりにレンダリングする要素またはコンポーネントです。コンポーネントは受け取ったpropsを1つの要素にスプレッドする必要があります。

すべての<button>属性も受け入れます。

データ属性値
data-leve-dialog-close常に存在
data-state"open" | "closed"

アクセシビリティ#

Dialog (Modal) WAI-ARIAデザインパターンに準拠しています。

  • Dialog.ContentはshowModal()で開かれるネイティブの<dialog>であるため、開いている間はページの残りの部分がinertになります。aria-modal="true"、Dialog.Titleを指すaria-labelledby、およびDialog.Descriptionを指すaria-describedbyをレンダリングします。
  • Dialog.Triggerは、aria-haspopup="dialog"、aria-expanded、およびContentを指すaria-controlsをレンダリングします。
  • ダイアログが開くと、フォーカスはその最初のフォーカス可能な要素に移動し(フォーカス可能な要素がない場合はContentに移動)、Tabによる移動はダイアログ内にとどまります。ダイアログが閉じると、開く前にフォーカスされていた要素、またはTriggerにフォーカスが戻ります。
  • ダイアログが開いている間、その背面にあるページはスクロールしません。
  • Dialog.Closeにアイコンのみが含まれる場合は、aria-labelを指定してください。

キーボード操作#

キー説明
Tabダイアログ内の次のフォーカス可能な要素にフォーカスを移動します。最後の要素からは、最初の要素に移動します。
Shift + Tabダイアログ内の前のフォーカス可能な要素にフォーカスを移動します。最初の要素からは、最後の要素に移動します。
EscapecloseOnEscapeがfalseでない限り、ダイアログを閉じます。