ドキュメントを検索

Switch

オプションのオン・オフを切り替えるコントロールです。

SwitchはSwitch WAI-ARIAデザインパターンに従います。

import { component$, useStyles$ } from '@builder.io/qwik';
import { Switch } from '@leve-ui/switch';
import styles from './default.css?inline';

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

  return (
    <Switch.Root class="switch-default-root">
      <Switch.Label class="switch-default-label">Airplane mode</Switch.Label>
      <Switch.Control class="switch-default-control">
        <Switch.Thumb class="switch-default-thumb" />
      </Switch.Control>
    </Switch.Root>
  );
});

インストール#

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

pnpm add @leve-ui/switch

構造#

import { Switch } from '@leve-ui/switch'; // or '@leve-ui/core'

<Switch.Root>
  <Switch.Label />
  <Switch.Control>
    <Switch.Thumb />
  </Switch.Control>
  <Switch.HiddenInput />
</Switch.Root>
パーツ要素説明
Switch.Root<div>各パーツをラップし、オン/オフの状態を保持します。インタラクティブではありません。
Switch.Label<label>ラベル。クリックするとスイッチが切り替わります。
Switch.Control<button>スイッチ自体で、role="switch"を持ちます。
Switch.Thumb<span>コントロール内のサムです。装飾用です。
Switch.HiddenInput<input type="checkbox">省略可能。ネイティブの<form>で状態を送信します。

例#

Checked#

defaultCheckedでスイッチを初期状態でオンにします。

Disabled#

Rootのdisabledでスイッチを無効化します。

フォーム#

nameを指定したSwitch.HiddenInputを追加して、ネイティブの<form>で状態を送信します。値はスイッチがオンのときのみ送信されます。

Fieldと併用#

Field.Root内では、Switch.Labelの代わりにField.Labelを使用してください。FieldがID、説明、およびdisabled/required/invalid状態を提供します。

Use a dark color scheme.

APIリファレンス#

Root#

Propデフォルト型
ids–{ control?: string; label?: string }

パーツの要素IDをオーバーライドします。Fieldの外でのみ使用されます。

defaultCheckedfalseboolean

スイッチが初期状態でオンかどうか(非制御)。

bind:checked–Signal<boolean>

オン/オフ状態を保持するシグナル(制御)。

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

ユーザーがスイッチをオンまたはオフにしたときに呼び出されます。

disabledfalseboolean

スイッチを無効化します。Fieldの内部では、Fieldのdisabledも適用されます。

requiredfalseboolean

スイッチを必須としてマークします。Fieldの内部では、Fieldのrequiredも適用されます。

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

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

状態はdefaultCheckedで非制御、またはbind:checkedで制御できます。onCheckedChange$は、ユーザーがスイッチをオンまたはオフにしたときに呼び出されます。

Fieldの内部では、IDはFieldから提供され、idsは無視されます(ADR 0024)。

Label#

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

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

Control#

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

データ属性値
data-leve-switch-control常に存在
data-state"checked" | "unchecked"
data-disabled無効時に存在
data-invalidFieldが無効な場合に存在

サム#

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

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

[data-leve-switch-thumb][data-state="checked"]などのCSSでサムを移動します。

HiddenInput#

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

データ属性値
data-leve-switch-hidden-input常に存在
data-state"checked" | "unchecked"
data-disabled無効時に存在

非表示のinputはchecked、required、disabledの状態に追従するため、ネイティブのフォーム送信とrequiredバリデーションが機能します(ADR 0026)。インラインスタイルで絶対配置されるため、Switch.Rootにposition: relativeを指定してください。

アクセシビリティ#

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

  • Switch.Label、Field.Label、またはSwitch.Control上のaria-label / aria-labelledbyでスイッチに名前を付けます。
  • Switch.Controlはrole="switch"およびaria-checked("true"または"false")、必須時はaria-requiredを持つ<button type="button">です。Fieldの内部ではaria-describedbyとaria-invalidもレンダリングします。無効時はネイティブのdisabled属性を使用するため、フォーカスを受け取りません。
  • 状態によってラベルのテキストを変更しないでください。状態はaria-checkedによって伝達されます。
  • Switch.ThumbとSwitch.HiddenInputはaria-hidden="true"によって支援技術から隠されます。非表示のinputはタブシーケンスに含まれません。

キーボード操作#

キー説明
Spaceスイッチをオンまたはオフにします。
Enterスイッチをオンまたはオフにします。