ドキュメントを検索

Radio Group

1つだけ選択できる選択肢のセットです。

Radio GroupはRadio GroupのWAI-ARIAデザインパターン(ロービングtabindexバージョン)に従います。

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

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

  return (
    <RadioGroup.Root class="radio-group-default-root">
      <RadioGroup.Label class="radio-group-default-label">Plan</RadioGroup.Label>
      <RadioGroup.Item value="free" class="radio-group-default-item">
        <RadioGroup.Indicator class="radio-group-default-indicator" />
        Free
      </RadioGroup.Item>
      <RadioGroup.Item value="starter" class="radio-group-default-item">
        <RadioGroup.Indicator class="radio-group-default-indicator" />
        Starter
      </RadioGroup.Item>
      <RadioGroup.Item value="pro" class="radio-group-default-item">
        <RadioGroup.Indicator class="radio-group-default-indicator" />
        Pro
      </RadioGroup.Item>
    </RadioGroup.Root>
  );
});

インストール#

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

pnpm add @leve-ui/radio-group

構造#

import { RadioGroup } from '@leve-ui/radio-group'; // or '@leve-ui/core'

<RadioGroup.Root>
  <RadioGroup.Label />
  <RadioGroup.Item>
    <RadioGroup.Indicator />
  </RadioGroup.Item>
  <RadioGroup.HiddenInput />
</RadioGroup.Root>
パーツ要素説明
RadioGroup.Root<div>role="radiogroup"を持つグループです。選択された値を保持します。
RadioGroup.Label<span>ラベルです。グループに名前を付けます。
RadioGroup.Item<button>role="radio"を持つ1つの選択肢です。
RadioGroup.Indicator<span>ドットやその他のアイコンを保持します。常に描画されます。
RadioGroup.HiddenInput<input type="radio">任意。ネイティブの<form>で選択された値を送信します。

例#

Controlled#

bind:valueはシグナルで選択された値を制御します。グループ外のボタンで値を変更でき、nullを設定すると選択がクリアされます。

Favorite fruit

Current value: banana

デフォルト値#

defaultValueは初期選択値を設定します。

Plan

Disabled#

Rootのdisabledはすべてのアイテムを無効化します。

Disabled group

無効化されたアイテム#

Itemのdisabledはそのオプションのみを無効化します。矢印キーでスキップされます。

Shipping method

水平方向#

orientation="horizontal"はグループを行方向にレイアウトします。aria-orientationとdata-orientationを設定します。

Payment method

Fieldと併用#

Field内では、グループはFieldのIDを使用し、そのinvalid、disabled、およびrequired状態を読み取ります。Field.DescriptionとField.ErrorMessageはaria-describedbyでリンクされます。グループの名前付けにはField.LabelではなくRadioGroup.Labelを使用してください。<label>でグループに名前を付けることはできません。

Shipping
Express arrives in one business day.

Formと併用#

RadioGroup.HiddenInputをnameとともに配置すると、ネイティブの<form>で選択された値を送信できます。

Subscription billing

APIリファレンス#

Root#

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

各パーツの要素IDを上書きします。Field内では、代わりにFieldのIDが使用されます。

defaultValuenullstring | null

初期選択される値(非制御)。

bind:value–Signal<string | null>

選択された値を保持するシグナル(制御)。

onValueChange$–QRL<(value: string) => void>

ユーザーが値を選択したときに呼び出されます。

orientation'vertical''horizontal' | 'vertical'

グループの向き。

looptrueboolean

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

disabledfalseboolean

すべてのラジオボタンを無効化します。

requiredfalseboolean

グループを必須としてマークします。

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

データ属性値
data-leve-radio-group常に存在
data-orientation"vertical" | "horizontal"
data-disabled無効時に存在
data-invalid囲んでいるFieldが無効な場合に存在します

選択された値はdefaultValueで非制御、またはbind:valueで制御されます。ユーザーが値を選択するとonValueChange$が呼び出されます。orientationはaria-orientationとdata-orientationのみを変更します。どちらの向きでも4つの矢印キーすべてで選択を移動できます。

Label#

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

データ属性値
data-leve-radio-group-label常に存在
data-disabledグループが無効化されている場合に存在

LabelのidはRootから提供されます。これを変更するには、Rootにids={{ label: '...' }}を渡します(Labelに指定したidも使用されますが、その場合は同じIDをRootのaria-labelledbyにも渡してください)。Field内では、FieldのラベルIDが使用されます。

Item#

Propデフォルト型
value (必須)–string

このラジオボタンの値。

disabledfalseboolean

このラジオボタンを無効化します。

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

データ属性値
data-leve-radio-group-item常に存在
data-state"checked" | "unchecked"
data-disabledアイテムまたはグループが無効化されている場合に存在
data-orientation"vertical" | "horizontal"

Indicator#

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

データ属性値
data-leve-radio-group-indicator常に存在
data-state"checked" | "unchecked"
data-disabledアイテムまたはグループが無効化されている場合に存在

インジケーターは常にレンダリングされます。[data-leve-radio-group-indicator][data-state="checked"]などのCSSを使用してコンテンツの表示・非表示を切り替えます。

HiddenInput#

Propデフォルト型
form–string

inputを関連付けるform要素のid。

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

データ属性値
data-leve-radio-group-hidden-input常に存在
data-state値が選択されている場合は"checked"、それ以外は"unchecked"
data-disabledグループが無効化されている場合に存在

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

アクセシビリティ#

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

  • RadioGroup.Label、またはRadioGroup.Rootのaria-label/aria-labelledbyでグループに名前を付けます。
  • RadioGroup.Rootはrole="radiogroup"、aria-orientation、および必須または無効時にaria-required/aria-disabledを描画します。Field内では、Field.Description/Field.ErrorMessage用のaria-describedbyと、Fieldが無効な間のaria-invalid="true"も描画します。
  • 各RadioGroup.Itemは、role="radio"とaria-checkedを持つ<button type="button">です。そのテキストコンテンツがアクセシブルな名前になります。無効化されたアイテムはネイティブのdisabled属性を使用するため、フォーカスできません。
  • タブシーケンスに含まれるのは1つのアイテムのみです。選択されたアイテム、または何も選択されていない場合は最初の有効なアイテムです。
  • RadioGroup.IndicatorとRadioGroup.HiddenInputはaria-hidden="true"によって支援技術から隠されます。

キーボード操作#

キー説明
Tabフォーカスをグループ内(選択されたアイテム、または最初の有効なアイテム)に移動するか、グループ外に移動します。
Spaceフォーカスされたアイテムを選択します。Enterは何もしません。
ArrowDown / ArrowRightフォーカスを次の有効なアイテムに移動して選択します。loopがtrueの場合、最初のアイテムに折り返します。
ArrowUp / ArrowLeftフォーカスを前の有効なアイテムに移動して選択します。loopがtrueの場合、最後のアイテムに折り返します。
Home有効な最初の項目にフォーカスを移動して選択します。
End有効な最後の項目にフォーカスを移動して選択します。