ドキュメントを検索

Drawer

詳細パネルのように、画面の端からスライドして表示されるパネル。

デフォルトでは、Drawerは非モーダルなダイアログです。開いている間もページの残りの部分を引き続き使用できます。modalを指定すると、Dialogと同様にDialog (Modal) WAI-ARIAデザインパターンに従います。

Order #1042

Shipped on November 12 to Osaka.

Items
3
Total
¥12,800
import { component$, useStyles$ } from '@builder.io/qwik';
import { Drawer } from '@leve-ui/drawer';
import { LuX } from '@qwikest/icons/lucide';
import styles from './default.css?inline';

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

  // Non-modal by default: the page stays usable while the panel is open
  return (
    <Drawer.Root class="drawer-default">
      <Drawer.Trigger class="drawer-default-trigger">Order details</Drawer.Trigger>
      <button type="button" class="drawer-default-trigger">
        Another page action
      </button>
      <Drawer.Content class="drawer-default-content">
        <Drawer.Title class="drawer-default-title">Order #1042</Drawer.Title>
        <Drawer.Description class="drawer-default-description">
          Shipped on November 12 to Osaka.
        </Drawer.Description>
        <dl class="drawer-default-list">
          <dt>Items</dt>
          <dd>3</dd>
          <dt>Total</dt>
          <dd>¥12,800</dd>
        </dl>
        <Drawer.Close class="drawer-default-close" aria-label="Close">
          <LuX class="drawer-default-icon" aria-hidden="true" />
        </Drawer.Close>
      </Drawer.Content>
    </Drawer.Root>
  );
});

使い分け#

コンポーネント用途
Drawerテーブル内の行の詳細など、ページが使用可能な状態のままコンテンツの横に開くパネル。
modalを指定したDrawer小さな画面でのナビゲーションメニューなど、ページをブロックするパネル。
Dialogページに戻る前に完了しなければならないタスクや決定。
通常の<aside>常に表示され、開閉することのないパネル。ダイアログではなく、レイアウトの一部です。

インストール#

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

pnpm add @leve-ui/drawer

構造#

import { Drawer } from '@leve-ui/drawer'; // or '@leve-ui/core'

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

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

Drawer.Contentはネイティブの<dialog>であり、配置した場所にレンダリングされ、トップレイヤーでページの上に表示されます。非モーダルドロワーはshowPopover()で表示されるpopover="manual"要素であり、モーダルドロワーはshowModal()で開かれます。sideはdata-sideを設定するだけです。デモのようにCSSでパネルとそのアニメーションを配置してください。モーダルドロワーにはバックドロップがあり、Dialogと同様に::backdropでスタイルを設定します。

例#

modalはページをブロックします。フォーカスはドロワー内にとどまり、ページはスクロールせず、バックドロップをクリックするとドロワーが閉じます。side="left"はdata-side="left"を設定します。

Navigation

Go to a section of the site.

APIリファレンス#

Root#

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

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

defaultOpenfalseboolean

ドロワーを初期状態で開いておくかどうか(非制御)。クライアント側から表示されるため、ページがレジュームしたときにドロワーが開きます。

bind:open–Signal<boolean>

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

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

ユーザーのインタラクションによってドロワーが開閉したときに呼び出されます。

modalfalseboolean

ドロワーをモーダルにするかどうか。Dialogと同様にフォーカスを閉じ込め、ページをブロックし、外部クリックで閉じます。デフォルトでは、ドロワーが開いている間もページを引き続き使用できます。

side'right''top' | 'right' | 'bottom' | 'left'

ドロワーが取り付けられる画面の端。data-sideを設定するだけです。CSSで配置してください。

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

データ属性値
data-leve-drawer常に存在
data-state"open" | "closed"
data-side"top" | "right" | "bottom" | "left"

開閉状態はdefaultOpenで非制御、またはbind:openで制御できます。onOpenChange$は、ユーザーがドロワーを開閉したときに呼び出されます。SSR HTMLは常にドロワーを閉じた状態でレンダリングします。初期状態で開いているドロワーは、ページがレジュームしたときに開きます。

Trigger#

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

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

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

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

トリガーはドロワーを切り替えます。非モーダルドロワーは、開いている間もトリガーを使用可能なままにします。

Content#

Propデフォルト型
closeOnEscapetrueboolean

Escapeでドロワーを閉じるかどうか。

closeOnOutsideClicktrueboolean

バックドロップでのポインターダウンでモーダルドロワーを閉じるかどうか。非モーダルドロワーは、外部のインタラクションによって閉じることはありません。

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

データ属性値
data-leve-drawer-content常に存在
data-state"open" | "closed"
data-side"top" | "right" | "bottom" | "left"

非モーダルドロワーは表示中に:popover-openに一致し、モーダルドロワーにはopen属性が付与されます。これらを@starting-styleと一緒に使用して、ドロワーが表示される際のアニメーションを設定します。

タイトル#

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

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

説明#

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

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

閉じる#

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

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

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

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

アクセシビリティ#

非モーダルダイアログ用のWAI-ARIA APGパターンはありません。非モーダルドロワーはaria-modalのないrole="dialog"であり、ドロワーとページの間でフォーカスを自由に移動できます(ADR 0028)。modalを指定すると、DrawerはDialog (Modal) WAI-ARIAデザインパターンに準拠します。

  • Drawer.Contentは、Drawer.Titleを指すaria-labelledby、Drawer.Descriptionを指すaria-describedbyをレンダリングし、modalの場合にのみaria-modal="true"をレンダリングします。
  • Drawer.Triggerは、aria-haspopup="dialog"、aria-expanded、およびContentを指すaria-controlsをレンダリングします。
  • ドロワーが開くと、フォーカスはその最初のフォーカス可能要素に移動します。閉じると、開く前にフォーカスされていた要素、またはTriggerにフォーカスが戻ります。フォーカスがページの他の場所にある間に非モーダルドロワーが閉じた場合、フォーカスは移動しません。
  • 非モーダルドロワーはフォーカスを閉じ込めたり、ページのスクロールを止めたりせず、ページがクリックされても閉じません。モーダルドロワーはこれら3つすべてを行います。
  • Drawer.Closeにアイコンのみが含まれる場合は、aria-labelを指定してください。

キーボード操作#

キー説明
Tab非モーダル:ドロワー内を順にフォーカス移動し、ページへと移動します。モーダル:ドロワー内のフォーカス可能要素間を循環します。
Shift + Tab同様に、逆方向にフォーカスを移動します。
EscapecloseOnEscapeがfalseでない限り、ドロワーを閉じます。