ドキュメントを検索

Menu

ボタンから開くアクションのリスト。

MenuはMenu Button WAI-ARIAデザインパターンに準拠しています。

import { $, component$, useSignal, useStyles$ } from '@builder.io/qwik';
import { Menu } from '@leve-ui/menu';
import { LuChevronDown } from '@qwikest/icons/lucide';
import styles from './default.css?inline';

export default component$(() => {
  useStyles$(styles);
  const last = useSignal('Nothing yet');
  const select$ = $((action: string) => {
    last.value = action;
  });

  return (
    <div class="menu-default">
      <Menu.Root>
        <Menu.Trigger class="menu-default-trigger">
          Actions
          <LuChevronDown class="menu-default-chevron" aria-hidden="true" />
        </Menu.Trigger>
        <Menu.Content sideOffset={4} class="menu-default-content">
          <Menu.Item onSelect$={() => select$('New file')} class="menu-default-item">
            New file <span class="menu-default-shortcut">⌘N</span>
          </Menu.Item>
          <Menu.Item onSelect$={() => select$('Duplicate')} class="menu-default-item">
            Duplicate <span class="menu-default-shortcut">⌘D</span>
          </Menu.Item>
          <Menu.Item disabled class="menu-default-item">
            Paste <span class="menu-default-shortcut">⌘V</span>
          </Menu.Item>
          <Menu.Separator class="menu-default-separator" />
          <Menu.Group>
            <Menu.GroupLabel class="menu-default-label">Share</Menu.GroupLabel>
            <Menu.Item onSelect$={() => select$('Copy link')} class="menu-default-item">
              Copy link
            </Menu.Item>
            <Menu.Item onSelect$={() => select$('Email')} class="menu-default-item">
              Email
            </Menu.Item>
          </Menu.Group>
        </Menu.Content>
      </Menu.Root>
      <p class="menu-default-status">Last action: {last.value}</p>
    </div>
  );
});

インストール#

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

pnpm add @leve-ui/menu

構造#

import { Menu } from '@leve-ui/menu'; // or '@leve-ui/core'

<Menu.Root>
  <Menu.Trigger />
  <Menu.Content>
    <Menu.Item />
    <Menu.Separator />
    <Menu.Group>
      <Menu.GroupLabel />
      <Menu.Item />
    </Menu.Group>
    <Menu.CheckboxItem>
      <Menu.ItemIndicator />
    </Menu.CheckboxItem>
    <Menu.RadioGroup>
      <Menu.RadioItem>
        <Menu.ItemIndicator />
      </Menu.RadioItem>
    </Menu.RadioGroup>
    <Menu.Sub>
      <Menu.SubTrigger />
      <Menu.SubContent>
        <Menu.Item />
      </Menu.SubContent>
    </Menu.Sub>
    <Menu.Arrow />
  </Menu.Content>
</Menu.Root>
パーツ要素説明
Menu.Root<div>各パーツをラップし、開閉状態を保持します。
Menu.Trigger<button>メニューを開くボタン。asを使用して別の要素またはコンポーネントをレンダリングします。
Menu.Content<div>トップレイヤーにあるpopover="manual"要素のメニュー。
Menu.Item<div>アクション。asを使用して<a>、Qwik Cityの<Link>、または別のコンポーネントをレンダリングします。
Menu.Group<div>GroupLabelによって名前が付けられるアイテムのグループ。
Menu.GroupLabel<div>グループの名前。アイテムではありません。
Menu.CheckboxItem<div>オンまたはオフを切り替えるアイテム。
Menu.RadioGroup<div>いずれか1つが選択されるRadioItemのセット。
Menu.RadioItem<div>RadioGroupのアイテム。
Menu.ItemIndicator<span>未選択時には非表示になる、CheckboxItemまたはRadioItemのチェックマーク。
Menu.Sub<div>サブメニューをラップし、その開閉状態を保持します。
Menu.SubTrigger<div>サブメニューを開くアイテム。
Menu.SubContent<div>SubTriggerの横に配置されるサブメニュー。
Menu.Separator<div>アイテム間の区切り線。
Menu.Arrow<div>任意。CSSで描画される、Triggerを指す矢印。

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

例#

リンクアイテム#

Menu.Itemのasに<a>またはQwik Cityの<Link>などのルーターリンクコンポーネントを渡すことで、role="menuitem"、キーボードナビゲーション、およびメニューのクローズを維持しながらアイテムをナビゲートできます。

CheckboxおよびRadioアイテム#

Menu.CheckboxItemはオプションのオン・オフを切り替え、Menu.RadioItemはMenu.RadioGroupの値を1つ選択します。どちらも他のコントロールと同様にbind:シグナルを受け取ります。Spaceを押すとメニューを閉じずに切り替わり、クリックまたはEnterを押すと切り替えてメニューを閉じます。

サブメニュー#

Menu.Subはメニューをネストします。Menu.SubTrigger上でArrowRight、Enter、またはSpaceを押すとサブメニューが開き、その最初のアイテムにフォーカスが移動します。ArrowLeftとEscapeはサブメニューのみを閉じます。SubTriggerにホバーするとサブメニューが開き、フォーカスはSubTriggerにとどまります。サブメニュー内のアイテムを選択すると、メニュー全体が閉じます。

Context Menu#

Menu.ContextTriggerは、ボタンからではなく、右クリック、Shift + F10、または長押しによってポインターの位置にメニューを開きます。Context Menuを参照してください。

APIリファレンス#

Root#

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

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

defaultOpenfalseboolean

初期状態でメニューを開くかどうか(非制御)。ページのレジューム時に開きます。

bind:open–Signal<boolean>

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

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

ユーザーの操作によってメニューが開閉されたときに呼び出されます。

loopfalseboolean

最後の項目でArrowDownを押したときに最初の項目へ、最初の項目でArrowUpを押したときに最後の項目へ移動するかどうか。

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

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

Trigger#

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

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

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

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

Content#

Propデフォルト型
side'bottom''top' | 'right' | 'bottom' | 'left'

メニューを配置するTrigger(またはコンテキストメニューのポインター)の側面です。空きスペースがない場合は反転します。

align'start''start' | 'center' | 'end'

その側に沿った配置方向。

sideOffset0number

Triggerからの距離(px)。

alignOffset0number

側に沿ったオフセット(px)。

avoidCollisionstrueboolean

メニューをビューポート内に収めるために反転およびシフトするかどうか。

collisionPadding0number

衝突を防ぐ際のビューポート端からのパディング(px)。

arrowPadding0number

矢印とメニューの角の間のパディング(px単位)。

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

データ属性値
data-leve-menu-content常に存在
data-state"open" | "closed"
data-side反転後の最終的な配置側:"top" | "right" | "bottom" | "left"
data-align"start" | "center" | "end"
CSS変数値
--leve-menu-anchor-widthTriggerの幅(メニューを少なくとも同じ幅にする場合などに使用)
--leve-menu-anchor-heightTriggerの高さ
--leve-menu-available-widthビューポートで利用可能な幅
--leve-menu-available-heightビューポート内で利用可能な高さ(max-heightなどに使用)

Contentが開いている間、インラインでposition、top、leftが設定されます。displayは:popover-openにのみ設定してください。Content自体に設定すると、閉じたpopoverに対するブラウザのdisplay: noneが上書きされてしまいます。

Item#

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

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

disabledfalseboolean

アイテムを無効化します。選択できなくなり、矢印キーでスキップされます。

onSelect$–QRL<() => void>

クリック、Enter、またはSpaceでアイテムが選択されたときに呼び出されます。

closeOnSelecttrueboolean

アイテムの選択時にメニューを閉じるかどうか。

textValue–string

アイテムのテキストコンテンツが適切でない場合に、先行入力(typeahead)で使用されるテキスト。

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

データ属性値
data-leve-menu-item常に存在
data-disabled無効時に存在
data-text-value設定されている場合のtextValue

フォーカスされたアイテムがハイライト表示されます。矢印キー、先行入力(typeahead)、ポインターでフォーカスが移動するため、:focusでスタイルを設定してください。

CheckboxItem#

Propデフォルト型
defaultCheckedfalseboolean

アイテムが初期状態で選択されているかどうか(非制御)。

bind:checked–Signal<boolean>

チェック状態を保持するシグナル(制御)。

onCheckedChange$–QRL<(checked: boolean) => void>

ユーザーがアイテムの選択または選択解除を行ったときに呼び出されます。

disabledfalseboolean

アイテムを無効にします。変更できなくなり、矢印キーでスキップされます。

closeOnSelecttrueboolean

クリックまたはEnterでメニューを閉じるかどうか。Spaceでは閉じません(APG)。

textValue–string

アイテムのテキストコンテンツが適切でない場合に、先行入力(typeahead)で使用されるテキスト。

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

データ属性値
data-leve-menu-checkbox-item常に存在
data-state"checked" | "unchecked"
data-disabled無効時に存在

RadioGroup#

Propデフォルト型
defaultValuenullstring | null

初期選択される値(非制御)。

bind:value–Signal<string | null>

選択された値を保持するシグナル(制御)。

onValueChange$–QRL<(value: string) => void>

ユーザーが値を選択したときに呼び出されます。

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

データ属性値
data-leve-menu-radio-group常に存在

RadioItem#

Propデフォルト型
value (必須)–string

この項目の値。

disabledfalseboolean

アイテムを無効化します。選択できなくなり、矢印キーでスキップされます。

closeOnSelecttrueboolean

クリックまたはEnterでメニューを閉じるかどうか。Spaceでは閉じません(APG)。

textValue–string

アイテムのテキストコンテンツが適切でない場合に、先行入力(typeahead)で使用されるテキスト。

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

データ属性値
data-leve-menu-radio-item常に存在
data-state"checked" | "unchecked"
data-disabled無効時に存在

ItemIndicator#

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

データ属性値
data-leve-menu-item-indicator常に存在
data-state"checked" | "unchecked"

インジケーターは、アイテムが未選択の間hidden属性を持ちます。

Sub#

Propデフォルト型
defaultOpenfalseboolean

初期状態でサブメニューが開いているかどうか(非制御)。

bind:open–Signal<boolean>

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

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

ユーザー操作によってサブメニューが開閉されたときに呼び出されます。

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

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

SubTrigger#

Propデフォルト型
disabledfalseboolean

アイテムを無効にします。サブメニューを開くことができなくなり、矢印キーでスキップされます。

textValue–string

アイテムのテキストコンテンツが適切でない場合に、先行入力(typeahead)で使用されるテキスト。

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

データ属性値
data-leve-menu-sub-trigger常に存在
data-state"open" | "closed"
data-disabled無効時に存在

SubContent#

Propデフォルト型
side'right''top' | 'right' | 'bottom' | 'left'

サブメニューを配置するSubTrigger側の位置。スペースがない場合は反転します。

align'start''start' | 'center' | 'end'

その側に沿った配置方向。

sideOffset0number

SubTriggerからの距離(px単位)。

alignOffset0number

側に沿ったオフセット(px)。

avoidCollisionstrueboolean

メニューをビューポート内に収めるために反転およびシフトするかどうか。

collisionPadding0number

衝突を防ぐ際のビューポート端からのパディング(px)。

arrowPadding0number

矢印とメニューの角の間のパディング(px単位)。

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

データ属性値
data-leve-menu-sub-content常に存在
data-state"open" | "closed"
data-side反転後の最終的な配置面
data-align"start" | "center" | "end"

サブメニューは、Contentと同じCSS変数を--leve-menu-sub-プレフィックス付きで公開します。

Group#

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

データ属性値
data-leve-menu-group常に存在

GroupLabel#

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

データ属性値
data-leve-menu-group-label常に存在

Separator#

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

データ属性値
data-leve-menu-separator常に存在

Arrow#

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

データ属性値
data-leve-menu-arrow常に存在
data-sideContentの最終的な配置側

アクセシビリティ#

Menu Button WAI-ARIAデザインパターンに準拠しています。

  • Menu.Triggerはaria-haspopup="menu"、aria-expanded、aria-controlsを描画します。Menu.Contentはrole="menu"を描画し、Triggerによってaria-labelledbyで名前が付けられます。
  • アイテムはrole="menuitem"とtabindex="-1"を描画します。キーボード操作でアイテム間をフォーカスが移動し(roving focus)、メニュー全体で1つのタブストップになります。
  • 無効化されたアイテムはaria-disabled="true"を描画します。読み上げはされますが選択できず、矢印キーでスキップされます。
  • Menu.Groupはrole="group"を描画し、そのMenu.GroupLabelによって名前が付けられます。
  • Menu.SubTriggerはaria-haspopup="menu"、aria-expanded、およびaria-controlsを持つrole="menuitem"を描画します。Menu.SubContentは、SubTriggerによって名前付けされたrole="menu"を描画します。
  • Menu.CheckboxItemとMenu.RadioItemは、aria-checkedを持つrole="menuitemcheckbox"/role="menuitemradio"をレンダリングします。Menu.RadioGroupはrole="group"をレンダリングします。aria-labelで名前を付けるか、ラベル付きのMenu.Group内に配置してください。aria-checkedが状態を伝えるため、Menu.ItemIndicatorは支援技術から隠されます。

キーボード操作#

キー説明
Enter / Space / ArrowDownTrigger上で、メニューを開き最初のアイテムにフォーカスを移動します。
ArrowUpTrigger上で、メニューを開き最後のアイテムにフォーカスを移動します。
ArrowDown / ArrowUp次の/前の有効なアイテムにフォーカスを移動します。loopが設定されている場合は循環します。
Home / End最初/最後の有効なアイテムにフォーカスを移動します。
文字入力された文字で始まる次のアイテムにフォーカスを移動します。
Enter / Spaceアイテム上で、そのアイテムを選択してメニューを閉じます。
Spaceチェックボックスまたはラジオアイテムで、メニューを閉じずに切り替えます。
Enterチェックボックスまたはラジオアイテムで、切り替えてメニューを閉じます。
ArrowRight / Enter / SpaceSubTrigger上では、サブメニューを開いてその最初のアイテムにフォーカスを移動します。
ArrowLeftサブメニュー内では、サブメニューを閉じてSubTriggerにフォーカスを戻します。
Escapeサブメニューまたはメニューを閉じ、SubTriggerまたはTriggerにフォーカスを戻します。
Tabメニューを閉じ、フォーカスを次に移動します。