ドキュメントを検索

Checkbox

チェックされている、チェックされていない、または不確定なコントロール。

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

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

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

  return (
    <Checkbox.Root class="checkbox-default-root">
      <Checkbox.Control class="checkbox-default-control">
        <Checkbox.Indicator class="checkbox-default-indicator">
          <LuCheck class="checkbox-default-icon" aria-hidden="true" />
        </Checkbox.Indicator>
      </Checkbox.Control>
      <Checkbox.Label class="checkbox-default-label">Accept terms and conditions</Checkbox.Label>
      <Checkbox.HiddenInput />
    </Checkbox.Root>
  );
});

インストール#

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

pnpm add @leve-ui/checkbox

構造#

import { Checkbox } from '@leve-ui/checkbox'; // or '@leve-ui/core'

<Checkbox.Root>
  <Checkbox.Control>
    <Checkbox.Indicator />
  </Checkbox.Control>
  <Checkbox.Label />
  <Checkbox.HiddenInput />
</Checkbox.Root>
パーツ要素説明
Checkbox.Root<div>各パーツをラップし、チェック状態を保持します。非インタラクティブです。
Checkbox.Control<button>チェックボックス本体(role="checkbox"付き)。
Checkbox.Indicator<span>チェックマークやその他のアイコンを保持します。常にレンダリングされます。
Checkbox.Label<label>ラベル。クリックするとチェックボックスが切り替わります。
Checkbox.HiddenInput<input type="checkbox">省略可能。ネイティブの<form>で状態を送信します。

例#

Checked#

defaultCheckedで初期状態を設定します。

Disabled#

Rootのdisabledはチェックボックスを無効化します。

Indeterminate#

「すべて選択」チェックボックスなどでは、チェック状態を"indeterminate"にできます。このデモでは、bind:checkedとonCheckedChange$を使用して状態を制御しています。

(1 of 3 selected)

Fieldと併用#

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

Save your session on this device for 30 days.

Formと併用#

ネイティブの<form>で状態を送信するには、nameとvalueを指定してCheckbox.HiddenInputを追加します。

APIリファレンス#

Root#

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

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

defaultCheckedfalseboolean | 'indeterminate'

初期のチェック状態(非制御)。

bind:checked–Signal<boolean | 'indeterminate'>

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

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

ユーザーがチェック状態を変更したときに呼び出されます。

disabledfalseboolean

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

requiredfalseboolean

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

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

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

チェック状態は、defaultCheckedによる非制御、またはbind:checkedによる制御が可能です。ユーザーが変更するとonCheckedChange$が呼び出されます。"indeterminate"のチェックボックスを切り替えるとチェック状態になります。

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

Control#

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

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

Indicator#

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

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

インジケーターは常にレンダリングされます。[data-leve-checkbox-indicator][data-state="unchecked"]などのCSSを使用してアイコンを表示または非表示にします。

Label#

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

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

HiddenInput#

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

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

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

アクセシビリティ#

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

  • チェックボックスの名前付けには、Checkbox.Label、Field.Label、またはCheckbox.Controlのaria-label / aria-labelledbyを使用します。
  • Checkbox.Controlはrole="checkbox"とaria-checked("true"、"false"または"mixed")をレンダリングし、必須の場合はaria-requiredもレンダリングします。Field内ではaria-describedbyとaria-invalidもレンダリングします。
  • 状態によってラベルのテキストを変更しないでください。状態はaria-checkedによって伝達されます。
  • Checkbox.IndicatorとCheckbox.HiddenInputはaria-hidden="true"によって支援技術から隠されます。

キーボード操作#

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