ドキュメントを検索

Toolbar

ボタンやトグルなどのコントロールが並び、タブストップが1つの行。

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

import { $, component$, type PropsOf, Slot, sync$, useSignal, useStyles$ } from '@builder.io/qwik';
import { ToggleGroup } from '@leve-ui/toggle-group';
import { Toolbar } from '@leve-ui/toolbar';
import {
  LuAlignCenter,
  LuAlignLeft,
  LuAlignRight,
  LuBold,
  LuItalic,
  LuUnderline,
} from '@qwikest/icons/lucide';
import styles from './default.css?inline';

// Example of a router link component (such as Qwik City's <Link>) that spreads received props onto <a>
const ClientLink = component$<PropsOf<'a'>>(({ onClick$, ...props }) => {
  const visited = useSignal(false);
  const preventDefault$ = sync$((event: MouseEvent) => {
    event.preventDefault();
  });
  const handleClick$ = $(() => {
    visited.value = true;
  });

  return (
    <a
      {...props}
      data-visited={visited.value ? 'true' : undefined}
      onClick$={[preventDefault$, handleClick$, onClick$]}
    >
      <Slot />
    </a>
  );
});

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

  return (
    <Toolbar.Root aria-label="Formatting" class="toolbar-default">
      {/* Toggle Group items inside a Toolbar join its arrow-key navigation */}
      <ToggleGroup.Root type="multiple" aria-label="Text style" class="toolbar-default-group">
        <ToggleGroup.Item value="bold" aria-label="Bold" class="toolbar-default-item">
          <LuBold class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
        <ToggleGroup.Item value="italic" aria-label="Italic" class="toolbar-default-item">
          <LuItalic class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
        <ToggleGroup.Item value="underline" aria-label="Underline" class="toolbar-default-item">
          <LuUnderline class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
      </ToggleGroup.Root>
      <Toolbar.Separator class="toolbar-default-separator" />
      <ToggleGroup.Root
        defaultValue={['left']}
        aria-label="Text alignment"
        class="toolbar-default-group"
      >
        <ToggleGroup.Item value="left" aria-label="Align left" class="toolbar-default-item">
          <LuAlignLeft class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
        <ToggleGroup.Item value="center" aria-label="Align center" class="toolbar-default-item">
          <LuAlignCenter class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
        <ToggleGroup.Item value="right" aria-label="Align right" class="toolbar-default-item">
          <LuAlignRight class="toolbar-default-icon" aria-hidden="true" />
        </ToggleGroup.Item>
      </ToggleGroup.Root>
      <Toolbar.Separator class="toolbar-default-separator" />
      <Toolbar.Link as={ClientLink} href="/history" class="toolbar-default-link">
        Edited 5 minutes ago
      </Toolbar.Link>
      <Toolbar.Button class="toolbar-default-button">Share</Toolbar.Button>
    </Toolbar.Root>
  );
});

インストール#

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

pnpm add @leve-ui/toolbar

構造#

import { Toolbar } from '@leve-ui/toolbar'; // or '@leve-ui/core'

<Toolbar.Root>
  <Toolbar.Button />
  <Toolbar.Separator />
  <Toolbar.Link />
</Toolbar.Root>
パーツ要素説明
Toolbar.Root<div>ツールバー。アイテム間でフォーカスを移動します。
Toolbar.Button<button>Toolbar内のボタンです。別の要素やコンポーネントをレンダリングするにはasを使用します。
Toolbar.Link<a>Toolbar内のリンクです。別の要素やルーターリンクコンポーネントをレンダリングするにはasを使用します。
Toolbar.Separator<div>アイテムのグループ間の区切り線。

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

Toolbar内に配置されたToggleおよびToggle Groupのアイテムは、自動的にツールバーアイテムになります。矢印キーでそれらすべてを移動できるようになり、Toggle Group自体は矢印キーの処理を行わなくなります。

例#

垂直方向#

orientation="vertical"はアイテムを垂直に並べるため、上矢印キーと下矢印キーでフォーカスが移動します。セパレーターは水平になります。無効化されたアイテムはスキップされ、ツールバー内のToggleもこれに参加します。

APIリファレンス#

Root#

Propデフォルト型
orientation'horizontal''horizontal' | 'vertical'

フォーカスを移動する矢印キーを決定するツールバーの向き。

looptrueboolean

矢印キーで最後の項目から最初の項目へ、またはその逆にラップするかどうか。

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

データ属性値
data-leve-toolbar常に存在
data-orientation"horizontal" | "vertical"

Button#

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

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

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

データ属性値
data-leve-toolbar-button常に存在
data-leve-toolbar-item常に存在(Toolbar内のToggleおよびToggle Groupアイテムにも存在)
data-disabled無効時に存在
Propデフォルト型
as'a'keyof HTMLElementTagNameMap | Component<any>

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

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

データ属性値
data-leve-toolbar-link常に存在
data-leve-toolbar-item常に存在

Separator#

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

データ属性値
data-leve-toolbar-separator常に存在
data-orientation水平ツールバーでは"vertical"、垂直ツールバーでは"horizontal"

アクセシビリティ#

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

  • Toolbar.Rootはrole="toolbar"およびaria-orientationをレンダリングします。aria-labelまたはaria-labelledbyで名前を指定してください。
  • ツールバーのタブストップは1つです。最初に有効なアイテム、その後は最後にフォーカスされたアイテムになります。他のアイテムにはtabindex="-1"が付与されます。
  • Toolbar.Separatorは、ツールバーと直交するaria-orientationを持つrole="separator"をレンダリングします。
  • 無効化されたボタンはネイティブのdisabled属性を使用し、矢印キーによる移動ではスキップされます。
  • アイコンのみのアイテムにはaria-labelを指定してください。

キーボード操作#

キー説明
Tabツールバー内(最後にフォーカスされたアイテム)にフォーカスを移動するか、ツールバー外へ移動します。
ArrowRight / ArrowLeft水平ツールバーにおいて、次または前のアイテムにフォーカスを移動します。loopがtrueの場合は最初または最後へ循環します。
ArrowDown / ArrowUp垂直ツールバーにおいて、次または前のアイテムにフォーカスを移動します。loopがtrueの場合は最初または最後へ循環します。
Home / End最初または最後のアイテムにフォーカスを移動します。
Enter / Spaceフォーカスされているアイテムをアクティブにします。