ドキュメントを検索

Context Menu

右クリックまたは長押しでポインターの位置に開くアクションメニューです。

コンテキストメニューは、Menu.Triggerの代わりにMenu.ContextTriggerによって開かれるMenuです。アイテム、グループ、チェックボックスおよびラジオアイテム、サブメニュー、キーボード操作はMenuと同じです。このメニューはMenu WAI-ARIAデザインパターンに準拠しています。

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

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

  return (
    <div class="menu-context">
      <Menu.Root>
        {/* Right-click (or long-press) anywhere in the area. Keyboard users press Shift+F10 on the button. */}
        <Menu.ContextTrigger class="menu-context-area">
          <span>Right-click here</span>
          <button type="button" class="menu-context-button">
            Or focus me and press Shift+F10
          </button>
        </Menu.ContextTrigger>
        {/* There is no Trigger to take the name from, so name the menu with aria-label */}
        <Menu.Content aria-label="Page" class="menu-context-content">
          <Menu.Item onSelect$={() => select$('Back')} class="menu-context-item">
            Back
          </Menu.Item>
          <Menu.Item disabled class="menu-context-item">
            Forward
          </Menu.Item>
          <Menu.Item onSelect$={() => select$('Reload')} class="menu-context-item">
            Reload
          </Menu.Item>
          <Menu.Separator class="menu-context-separator" />
          <Menu.Sub>
            <Menu.SubTrigger class="menu-context-item">
              More tools
              <LuChevronRight class="menu-context-icon" aria-hidden="true" />
            </Menu.SubTrigger>
            <Menu.SubContent alignOffset={-5} class="menu-context-content">
              <Menu.Item onSelect$={() => select$('Save page as')} class="menu-context-item">
                Save page as…
              </Menu.Item>
              <Menu.Item onSelect$={() => select$('Developer tools')} class="menu-context-item">
                Developer tools
              </Menu.Item>
            </Menu.SubContent>
          </Menu.Sub>
        </Menu.Content>
      </Menu.Root>
      <p class="menu-context-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.ContextTrigger />
  <Menu.Content aria-label="...">
    <Menu.Item />
  </Menu.Content>
</Menu.Root>
パーツ要素説明
Menu.Root<div>各パーツをラップし、開閉状態を保持します。
Menu.ContextTrigger<div>メニューを開く領域です。
Menu.Content<div>トップレイヤーにあるpopover="manual"要素のメニュー。

その他のパーツはMenuと同じです。Root内ではMenu.TriggerまたはMenu.ContextTriggerのいずれか一方のみを使用し、両方は使用しないでください。

動作#

  • 領域内を右クリック(macOSではControl + クリック)すると、ブラウザのメニューの代わりにポインターの位置にメニューが開きます。開いている間に領域内の別の場所を右クリックすると、そこへメニューが移動します。
  • 領域内のフォーカスされた要素でShift + F10またはContextMenuキーを押すと、その要素の下にメニューが開きます。領域自体はフォーカスを受け取らないため、フォーカス可能なコンテンツ(ファイルリスト、tabindex="0"付きのcanvasなど)を内部に配置してください。
  • タッチスクリーンでは、長押し(700ms、指が動いた場合はキャンセル)によってタッチした位置にメニューが開きます。ブラウザがテキストを選択したり独自のコールアウトを表示したりしないよう、領域にuser-select: noneと-webkit-touch-callout: noneを追加してください。
  • メニューは最初のアイテムにフォーカスを合わせます。Escapeまたはアイテムの選択で閉じ、キーボードで開いた場合は、フォーカスが開く前にフォーカスされていた要素に戻ります。
  • disabledを設定すると、領域はメニューを開かず、ブラウザのメニューが表示されます。

APIリファレンス#

ContextTrigger#

Propデフォルト型
disabledfalseboolean

領域がメニューを開かないようにするかどうかです。代わりにブラウザ独自のコンテキストメニューが表示されます。

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

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

Contentはside="bottom"およびalign="start"でポインターの位置に配置され、ビューポート内に収まるように反転またはシフトします。side、alignおよびオフセットの各propsはTriggerと同様に機能します。その他のパーツについてはMenuを参照してください。

アクセシビリティ#

  • Menu.ContextTriggerはroleをレンダリングしません。領域は独自のコンテンツであり、そのセマンティクスが保持されます。
  • メニューに名前を付けるTriggerが存在しないため、Menu.Contentにaria-label(またはaria-labelledby)を指定してください。
  • キーボードユーザーは、領域内のフォーカス可能な要素でShift + F10またはContextMenuキーを押してメニューを開きます。領域内にフォーカス可能な要素があることを確認し、コンテキストメニューは見つけにくいため、可能であれば他の場所でも同じアクションを提供してください。

キーボード操作#

キー説明
Shift + F10 / ContextMenu領域内のフォーカスされた要素でメニューを開き、最初のアイテムにフォーカスを合わせます。
Escapeメニューを閉じ、開く前にフォーカスされていた要素にフォーカスを戻します。

メニュー内のキー操作はMenuと同じです。