ドキュメントを検索

Toggle

押された状態または押されていない状態を持つボタンです。

ToggleはButton WAI-ARIAデザインパターンのトグルボタンバリアントに準拠しています。aria-pressedを持つネイティブの<button>をレンダリングします。

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

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

  return (
    <Toggle.Root class="toggle-default" aria-label="Bold">
      <LuBold class="toggle-default-icon" aria-hidden="true" />
    </Toggle.Root>
  );
});

インストール#

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

pnpm add @leve-ui/toggle

構造#

import { Toggle } from '@leve-ui/toggle'; // or '@leve-ui/core'

<Toggle.Root />
パーツ要素説明
Toggle.Root<button>トグルボタン。押下状態を保持します。

例#

Controlled#

bind:pressedはシグナルを使って押下状態を制御します。Toggleの外にあるResetボタンがそれを変更します。

Bold: off

Disabled#

disabledはToggleを無効化します。

Pressed#

defaultPressedにより、初期状態でToggleが押された状態になります。

APIリファレンス#

Root#

Propデフォルト型
defaultPressedfalseboolean

トグルが初期状態で押されているかどうか(非制御)。

bind:pressed–Signal<boolean>

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

onPressedChange$–QRL<(pressed: boolean) => void>

ユーザーがトグルを押した、または離したときに呼び出されます。

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

データ属性値
data-leve-toggle常に存在
data-state"on" | "off"
data-disabled無効時に存在

押下状態はdefaultPressedで非制御、またはbind:pressedで制御できます。onPressedChange$はユーザーがToggleを押したとき、または解除したときに呼び出されます。disabledはネイティブのbutton属性です。

アクセシビリティ#

Button WAI-ARIAデザインパターン(トグルボタン)に準拠しています。

  • Toggle.Rootはaria-pressed("true"または"false")を持つ<button type="button">です。無効化されている場合はネイティブのdisabled属性を使用するため、フォーカスできません。
  • そのテキストコンテンツがアクセシブルな名前になります。アイコンのみのToggleの場合は、aria-labelを渡し、アイコンをaria-hidden="true"で非表示にします。
  • 状態に応じてラベルを変更しないでください(例えば、「Mute」のままにし、「Unmute」に切り替えないでください)。状態はaria-pressedによって伝達されます。
  • Toolbarの内部では、トグルはツールバーのroving tabindexに参加します。矢印キーでフォーカスが移動し、ツールバー内でタブストップとなるアイテムは1つだけになります。

キーボード操作#

キー説明
SpaceToggleを押す、または解除します。
EnterToggleを押す、または解除します。