チェックボックスグループ
一度に見せられる数の選択肢から、複数を選んで答える 1 つの質問です。1 つのラベルの下にチェックボックスが並び、説明と 1 つのエラーが付きます。チェックが入った値のリストを 1 つの名前で持ち、すべてにチェックを入れるチェックボックスを添えることもできます。
- カテゴリ
- 選択
- トークン
comp.field-group- レベル
- 合成
- 構成要素
- Field group, Checkbox
- Web
tanrei-checkbox-groupschedule - SwiftUI
TanreiCheckboxGroupradio_button_unchecked - Jetpack Compose
TanreiCheckboxGroupradio_button_unchecked - Flutter
TanreiCheckboxGroupradio_button_unchecked - React Native
CheckboxGroupradio_button_unchecked
生成元 docs/status/status.json, specs/checkbox-group.spec.json
チェックボックスグループと、すべてにチェックを入れるチェックボックスを添えたもの
チェックボックスグループは、答えがリストになる 1 つの質問で、選択肢を一度に見せられる数（7 つくらいまで）のときに使います。通知の受け取り方法、レポートを送る曜日、リストを絞り込む種類などです。答えは 1 つの値、つまりチェックが入った値のリストで、フォームは 1 つの名前で送信します。
構成要素は、フィールドグループとチェックボックスです。フィールドグループは枠で、ラベル、必須または任意の印、説明、エラー、縦または横の並びを受け持ちます。チェックボックスは値を受け持ちます。1 つ 1 つが自分のラベルを持つ選択肢で、どれにチェックが入っているかがリストになります。チェックボックスグループが自分で描くものはなく、トークンもありません。2 つに加えるのは、プロダクトがいつも自分で書くことになる状態です。リストとそのための 1 つの change、フォームでの 1 つの名前とリセット、必須の集まりが空でないことをフォーム自身が確かめること、そして、すべてにチェックを入れるチェックボックスの 3 つの状態です。
幅は、置かれた場所に合わせて広がります。
Web では <tanrei-checkbox-group> です。ほかのプラットフォームはまだ実装していません。
チェックボックスは、それぞれ自分の value が示す選択肢です。グループの value は、チェックが入った値のリストで、チェックボックスの並び順になります。どのチェックボックスにもない値がリストにあっても、そのまま残ります。検索で絞り込まれて見えなくなった選択肢は、選ばれたままです。
<form>
<tanrei-checkbox-group name="notify" label="通知の受け取り方法"
supporting-text="当てはまるものをすべて選んでください。"
required required-text="必須"
error-text="連絡方法を 1 つ以上選んでください。">
<tanrei-checkbox value="email" label="メール" checked></tanrei-checkbox>
<tanrei-checkbox value="text" label="SMS"></tanrei-checkbox>
<tanrei-checkbox value="push" label="プッシュ通知"></tanrei-checkbox>
</tanrei-checkbox-group>
</form>
<script type="module">
import '@tanrei/web/components/checkbox-group';
const group = document.querySelector('tanrei-checkbox-group');
group.addEventListener('change', (event) => {
// event.detail.value が新しいリストです。group.value はすでに同じ値になっています。
group.error = event.detail.value.length === 0;
});
// 答えはリストで設定します。プロパティであり、value 属性はありません。
group.value = ['email', 'push'];
</script>import { Checkbox, CheckboxGroup } from '@tanrei/react';
const [channels, setChannels] = useState(['email']);
<CheckboxGroup name="notify" label="通知の受け取り方法" supportingText="当てはまるものをすべて選んでください。"
value={channels} onChange={(event) => setChannels(event.detail.value)}
error={channels.length === 0} errorText="連絡方法を 1 つ以上選んでください。">
<Checkbox value="email" label="メール" />
<Checkbox value="text" label="SMS" />
<Checkbox value="push" label="プッシュ通知" />
</CheckboxGroup>マークアップでは、最初の値を HTML と同じ場所、つまりチェックボックスの checked に書きます。プロダクトが value を設定した後は、どれにチェックが入るかを value が決めます。
selectAllLabel を指定すると、グループは最初のチェックボックスの前にもう 1 つのチェックボックスを置き、そのテキストを名前にします。ユーザーが切り替えられるチェックボックスのすべてにチェックが入っていればチェック、一部なら中間状態、1 つもなければ未チェックになります。未チェックか中間状態のときに押すとすべてにチェックが入り、チェックのときに押すとすべて外れます。リストの項目ではなく、何も送信しません。
<tanrei-checkbox-group name="days" label="レポートを送る曜日" select-all-label="平日すべて">
<tanrei-checkbox value="mon" label="月曜日"></tanrei-checkbox>
<tanrei-checkbox value="tue" label="火曜日"></tanrei-checkbox>
…
</tanrei-checkbox-group>利用者側で無効にしたチェックボックスは、チェックが入っていてもいなくても、そのままになり、数に含まれません。このチェックボックスが数えるのは、ユーザーが切り替えられる選択肢だけです。ラベルは、その集まりのための言葉（「これらすべて」「平日すべて」など）を、質問の言い方に合わせて書きます。プロダクトの言葉から読まれることはありません。
同じ集まりを 2 つの構成要素から自分で書いても、見た目は同じで、支援技術にとっても同じグループになります。
<tanrei-field-group label="通知の受け取り方法" supporting-text="当てはまるものをすべて選んでください。"
required required-text="必須">
<tanrei-checkbox name="notify" value="email" label="メール" checked></tanrei-checkbox>
<tanrei-checkbox name="notify" value="text" label="SMS"></tanrei-checkbox>
<tanrei-checkbox name="notify" value="push" label="プッシュ通知"></tanrei-checkbox>
</tanrei-field-group>同じ集まりを自分で書いたもの。フィールドグループの中にチェックボックスがあります
フィールドグループとチェックボックスを自分で書いたものにないのは、答えを持つことです。
| 観点 | 自分で書いた場合 | チェックボックスグループ |
|---|---|---|
| リスト | プロダクトがチェックボックスを 1 つずつ読む | value と、1 つの change |
| 答えを設定する | チェックボックスごとの checked |
value = […] |
| リセットと復元 | チェックボックスがそれぞれ行う | 1 つのコントロール |
| 必須の集まりが空のまま | プロダクトが確かめる | フォーム自身の検証が受け付けない |
| チェックボックスが表示されていない値 | 失われる | 残る |
| すべてにチェックを入れるチェックボックス | プロダクトが indeterminate を使って書く |
selectAllLabel |
| フォームが送信するもの | 同じ項目 | 同じ項目 |
集まりが 1 つの答えでないときに、1 つ下の階層で書きます。
| 必要なもの | 使うもの |
|---|---|
| いくつかの選択肢から複数を選ぶ、1 つの名前を持つ 1 つの答え | チェックボックスグループ |
| フォームでそれぞれ自分の名前を持つチェックボックス。または、チェックボックスでないものを含む集まり | フィールドグループにチェックボックスを入れる |
| 「すべて」の意味を自分で決める（ページにあるすべての項目、条件に合うすべての項目など） | フィールドグループに、自分で indeterminate を設定するチェックボックスを入れる |
| いくつかの選択肢から 1 つ | ラジオグループ |
| 1 つのことのオンとオフ | チェックボックス。すぐに反映されるものはスイッチ |
| 多くの選択肢から複数。または、場所が狭い | セレクト、または複数選択のリスト |
横並び、受け付けられなかった回答、いつもオンの選択肢、無効なグループ
| 観点 | フィールドグループから | チェックボックスから | グループ自身のもの |
|---|---|---|---|
| プロパティ | label、labelHidden、supportingText、errorText、error、disabled、required、optional、requiredMark、requiredText、optionalText、orientation |
各チェックボックスの value、label、disabled。チェックボックスに指定する |
value、selectAllLabel |
| イベント | — | なし。グループの中のチェックボックスは、自分のイベントを発生させない | change |
| トークン | comp.field-group.* |
comp.checkbox.* |
なし |
- 必須は、1 つ以上という意味です。最小や最大の数（「3 つまで選べます」など）は、利用者側の決まりです。
changeでリストの長さを読み、errorを設定し、数を含めた自分の言葉でerrorTextを書きます。 - エラーは、集まりのものです。
errorは、最後のチェックボックスの下にerrorTextを描き、すべてのチェックボックスをそれぞれのエラーの状態にします。グループが自分で設定することはなく、値が変わっても解除されません。エラーでないグループの中の 1 つのチェックボックスだけをエラーにするには、そのチェックボックスのerrorを使います。 - 無効。 無効なグループは値を保ち、何も送信しません。有効なグループの中で 1 つだけ無効にしたチェックボックスは、リストの項目を保ち、一緒に送信されます。いつもオンの選択肢は、無効でチェックが入った 1 つのチェックボックスで表せ、隣に隠しフィールドを置く必要はありません。
- 読み取り専用の状態はありません。チェックボックスにないためです。
枠の動き（必須の印、説明、エラーとその読み上げ、縦の並びと折り返す横の並び）はフィールドグループのページに、チェックボックスの動きはチェックボックスのページにあります。
チェックボックスグループに自分のトークンはありません。枠はフィールドグループのトークンを、チェックボックスはチェックボックスのトークンを、どこで設定されていても読みます。1 つだけ変えるには、構成要素のトークンをその要素に設定します。
<tanrei-checkbox-group label="通知の受け取り方法"
style="--tanrei-comp-field-group-gap-controls: 12px">…</tanrei-checkbox-group>構成要素
| パーツ | 説明 |
|---|---|
1 label | The field group's label: names the set — the question — above the checkboxes. The requirement mark follows it. |
2 requirement-label · 任意 | The field group's requirement mark: a small tag that is not a control, saying an answer is required or optional; or, for required, an asterisk after the label. |
3 supporting-text · 任意 | The field group's description: a line under the label, before the checkboxes, that says how to answer. It stays while the group is in error. |
4 select-all · 任意 | One more checkbox before the first, brought by the group where selectAllLabel is given: the Checkbox component, checked, unchecked or indeterminate from the checkboxes of the set, and checking or unchecking them all. It is no entry of the value. |
5 checkboxes | The checkboxes of the set, in the order given, in a column or in a row that wraps. Each is the Checkbox component with its own label, drawn from its own tokens; which of them are checked is the group's value. |
6 error-text · 任意 | The field group's error text: the reason the answer was refused or is missing, below the last checkbox. |
プロパティ
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
value | strings | | The values of the checked checkboxes: a list of strings, empty while none is checked (the platforms whose idiom it is take a set). The checkbox group sets it when a person switches a checkbox, and emits change; the product may also set it. It is the set's value: what a form submits under the group's one name. |
label | string | "" | Names the set, visibly and to assistive technology: the question its controls answer ("Notify me by"). Required. — Field group |
labelHidden | boolean | false | Does not draw the label, which stays the accessible name of the group. For a set whose visible heading is elsewhere. — Field group |
supportingText | string | "" | The description: how to answer ("Choose all that apply"), drawn under the label and given to assistive technology as the group's description. — Field group |
errorText | string | "" | What is wrong with the set as a whole and how to put it right ("Choose at least one"), drawn below the controls while error is true. — Field group On the web it is also what the form's own validation says of a required group left empty (CKG-8). |
error | boolean | false | Puts the set in the error condition: the error text is drawn, and each selection control that has an error condition of its own (a checkbox, a radio button) is drawn in it. What an answer means is the product's to validate; the group never sets this itself. One control of a valid group may still be in error by itself. — Field group Every checkbox of the set is drawn in its own error condition and exposed as invalid. |
disabled | boolean | false | Disables every control of the set and draws the frame as disabled. — Field group The value is kept, and on the web it is not submitted (CKG-6, CKG-8). |
required | boolean | false | What the form asks of the set: true exposes it as required and draws the required mark beside the label. It never validates: a missing answer is the product's to report with error. — Field group means at least one checkbox checked: on the web an empty list is reported to the form's own validation (CKG-8). |
optional | boolean | false | Draws the optional tag after the label and adds optionalText to the group's description, because assistive technology has no state for it. Ignored while required is true: a set is never both. — Field group |
requiredMark | auto | tag | asterisk | none | "auto" | How this set shows that it is required: tag is a small filled Tag with requiredText, asterisk is "*" after the label, none draws nothing and keeps the semantics. Auto takes comp.field-group.requirement.mark, which follows sys.behavior.requirement-mark, the system's one answer. Ignored unless required is true. — Field group |
requiredText | string | "" | The text of the required tag, in the product's language ("Required", "必須"). The product's: Tanrei has no word for it. Empty reads the product's words; with neither, FGR-24 says what is drawn. — Field group |
optionalText | string | "" | The text of the optional tag, in the product's language ("Optional", "任意"); also read to assistive technology as part of the description. The product's: Tanrei has no word for it. Empty reads the product's words. — Field group |
orientation | vertical | horizontal | "vertical" | vertical stacks the controls in one column, the default and the form to prefer: every label starts on one edge and is read down. horizontal lays them out in a row that wraps, for two or three short options or a row of fields. — Field group |
selectAllLabel | string | "" | Not empty: the group brings one more checkbox before the first, labelled by this text ("All of these", "Every weekday"), that checks or unchecks every enabled checkbox of the set at once and shows checked, unchecked or indeterminate from them (CKG-12, CKG-13). Empty, the default: there is none. The instance's own words: it names this set, so it is not read from the product's words. |
イベント
| イベント | 説明 |
|---|---|
change | The person switched a checkbox of the set, or activated the select-all checkbox; carries the new list, which the group already holds. Emitted once per action, by the group and not by its checkboxes. Not emitted when the product sets value. |
アイテム
このコンポーネントが繰り返すアイテムの種類です。フィクスチャはアイテムを順に並べ、各プラットフォームはそれぞれの流儀で種類ごとに名前を付けます。
checkbox
A choice of the set: the Checkbox component with its own label, checked by the group's value, placed, spaced, disabled and put in its error condition by the group's frame, otherwise drawn and pressed as it is anywhere.
| プロパティ | 型 | 既定値 | 説明 |
|---|---|---|---|
value | string | "" | What the choice stands for: an entry of the group's value while this checkbox is checked. Unique in the group and not empty. The group reads it from the item; it is not a prop of the Checkbox (on the web, the checkbox's own value attribute). |
label | string | "" | Its own label, as the Checkbox's label. |
disabled | boolean | false | As the Checkbox's disabled: one checkbox of an enabled group may be disabled by itself. The person cannot switch it, the select-all checkbox leaves it alone, and its entry stays in the value while the value holds it. |
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| アイテム | tanrei-checkbox | TanreiCheckbox | TanreiCheckbox | TanreiCheckbox | Checkbox |
value · プロパティ | value | value | value | entry | entry |
label · プロパティ | label | title | label | label | label |
disabled · プロパティ | disabled | disabled | enabled | enabled | disabled |
| 備考 | A tanrei-checkbox child: inside a tanrei-checkbox-group it takes its checked from the group's value and its own value attribute, submits nothing itself and fires no input or change of its own (CHK-23). A child with no value attribute has no value: the on a bare checkbox submits by default is not read inside a group. | TanreiCheckbox.value is the checked state on this platform, so the entry a checkbox stands for has a name of its own: TanreiCheckbox<T>.inGroup(entry:, label:, enabled:) is the Checkbox itself, checked from the group and without value and onChanged. | Checkbox's value is the checked state on this platform, so the entry a checkbox stands for has a name of its own: <Checkbox entry="email" label="Email" /> inside a CheckboxGroup is the Checkbox itself, checked from the group's context and without value and onValueChange. |
状態
振る舞い
EARS 記法による要件です。各プラットフォームの実装は、この ID に対応するテストで検証されます。要件の原文は仕様ファイルのものをそのまま掲載しています。
| ID | 要件 |
|---|---|
CKG-1 | THE checkbox group SHALL be a field group whose spacing is controls, around its checkboxes: the field group itself, with the field group's own tokens, measures and sentences, and no copy of it — its rows, their order and their gaps (FGR-1), the label (FGR-2), the requirement, its mark and its words (FGR-4, FGR-5, FGR-6, FGR-24), the description, which stays while the group is in error (FGR-7), the error text (FGR-8), the column and the row that wraps (FGR-3, FGR-13), the disabled frame (FGR-14) and what an unknown value of required, optional, requiredMark or orientation does (FGR-22), each from the prop of the same name, which is the field group's. It SHALL have no look and no token of its own: it SHALL draw no container, edge, fill or elevation, SHALL add no padding around its rows and no distance between its checkboxes but the field group's, and SHALL leave each checkbox drawn from the checkbox's own tokens at the checkbox's own size (CHK-4, CHK-12, CHK-15). |
CKG-2 | THE checkbox group SHALL hold one value, a list of strings, and show as checked exactly those of its checkboxes whose value is in the list; WHILE the list is empty none SHALL be checked. WHEN the product sets value THE checkbox group SHALL check and uncheck its checkboxes to match, each over the checkbox's own selection motion (CHK-13), without emitting change and without moving focus. THE checkbox group SHALL keep in value an entry that is the value of none of its checkboxes, because the checkbox it belongs to may arrive later or be out of the set for now (a list of choices narrowed by a search), and SHALL give it back with the rest in change (CKG-4) and to a form (CKG-8). IF value holds one entry twice THEN THE checkbox group SHALL treat it as held once; IF two checkboxes carry one value THEN both SHALL be shown checked or unchecked together, and switching either SHALL switch the entry; IF a checkbox carries no value THEN it SHALL be drawn unchecked and a press on it SHALL change nothing and emit nothing, because the list has no entry to stand for it; and in debug builds THE checkbox group SHALL report each of the three. |
CKG-3 | WHERE the platform lets the product mark one checkbox as checked by itself (on the web, checked on a child element) and the product has not set value, THE checkbox group SHALL take as its value the values of the checkboxes so marked, in the order given, so that markup that says checked on some of its checkboxes is a group with that value, and a checkbox that arrives so marked SHALL add its value to the list. WHEN the product has set value, value SHALL decide: a checkbox that is first drawn or arrives marked against it SHALL be shown as value says. WHEN the product sets or clears checked on a checkbox the checkbox group already holds THE checkbox group SHALL add that checkbox's value to the list or take it out, without emitting change, so that the two never disagree. |
CKG-4 | WHEN the person switches one of the group's checkboxes — by pointer, touch, Space, a click on its label or assistive technology, as CHK-1 says of the checkbox — THE checkbox group SHALL add that checkbox's value to the list where the checkbox became checked and take it out where it became unchecked, and SHALL emit change exactly once, carrying the new list, with value already set when the event is received. The list it then holds SHALL be the values of its checked checkboxes in the order the checkboxes are given, not the order in which they were checked, followed by the entries that belong to no checkbox, in the order they had. No other checkbox SHALL change, and nothing the checkbox emits SHALL reach a listener on the group as a second change (CHK-23). A person can empty the list: unchecking the last checked checkbox emits change with an empty list. |
CKG-5 | THE checkbox group SHALL leave every enabled checkbox its own place in the focus order, in the order given, as the platform has it for checkboxes: Tab and Shift+Tab SHALL move from one checkbox to the next and out of the group at either end, and THE checkbox group SHALL handle no key — no arrow key moves focus or checks, and there is no single stop and no roving focus — because each checkbox is a choice of its own that a person may stop at and switch; Space is the checkbox's (CHK-1), and Enter is left to the form on the web. THE checkbox group SHALL NOT be a stop itself, and a press on its label, its requirement mark, its description or its error text SHALL check nothing and move no focus into the group (FGR-12). WHEN the product asks the group itself for focus, where the platform has such a call, THE checkbox group SHALL give focus to the first enabled checkbox it shows, the select-all checkbox where one is drawn. |
CKG-6 | WHILE disabled is true THE checkbox group SHALL be a disabled field group (FGR-14): its frame drawn from the field group's disabled tokens and every checkbox it holds disabled as the checkbox's own disabled does (CHK-3, CHK-8), the checked ones still shown checked; it SHALL emit no change and SHALL keep value. WHILE disabled is false THE checkbox group SHALL NOT enable a checkbox the product disabled itself: that one keeps its entry in the list WHILE the list holds it, is shown checked or unchecked as value says, cannot be switched by the person, and is left as it is by the select-all checkbox (CKG-13). THE checkbox group SHALL have no read-only state, because a checkbox has none and a composed component adds no state its members have not. |
CKG-7 | THE checkbox group SHALL take from required and optional what the form asks of the set, as a field group does (FGR-4): required means that the list holds at least one entry. |
CKG-8 | WHERE the platform has forms that submit named values (the web) THE checkbox group SHALL take part in its form as one control: WHILE it is not disabled it SHALL submit one entry under its own name for each entry of value, in the list's order, and nothing WHILE the list is empty — what checkboxes of one name submit by themselves, so that whatever receives the form reads the same list from either; SHALL return to the value it was first given WHEN the form is reset, without emitting change; SHALL be disabled WHILE the form disables the set it is in; SHALL report a missing value to the form's own validation WHILE required is true and the list is empty, in the product's words, because the platform has a message for one unchecked checkbox and none for a set; and its checkboxes, the select-all checkbox among them, SHALL submit nothing of their own, whatever name they carry (CHK-23), so that no entry is submitted twice. A checkbox the product disabled itself SHALL still have its entry submitted WHILE the list holds it, because the value is the group's and that checkbox's disabled says only that the person cannot switch it. WHERE the platform has no such forms value and change are the whole of it. |
CKG-9 | THE checkbox group SHALL be exposed to assistive technology as the field group it is, and SHALL add nothing to it: one group that contains its checkboxes, named by label whether or not the label is drawn (FGR-10); described by supportingText, errorText WHILE error is true, requiredText WHILE required is true and optionalText WHILE optional is true (FGR-11); and disabled WHILE disabled is true (FGR-14). A group has neither a required nor an invalid state, so the requirement is said in the product's words and each checkbox says invalid for itself. Each checkbox SHALL expose its own role, its name and its checked state (CHK-14), and the select-all checkbox its mixed state WHILE it is indeterminate. THE checkbox group SHALL NOT expose a second group around the first, SHALL give its checkboxes no position in a set, and SHALL NOT say how many are checked: a product that wants the count said writes it in supportingText. |
CKG-10 | WHEN a checkbox is added to the group, removed from it or moved, or its value or its disabled changes, while the group is shown THE checkbox group SHALL be laid out again as a field group is (FGR-23); SHALL check by value again (CKG-2), so that a checkbox that arrives with a value the list holds is shown checked, and SHALL keep the entry of a checked checkbox that leaves; SHALL set the select-all checkbox again (CKG-12); SHALL emit no change; and SHALL leave focus on the checkbox that has it. |
CKG-11 | THE checkbox group SHALL hold checkboxes and nothing else that can be operated. IF it holds no checkbox THEN THE checkbox group SHALL draw its rows without one and in debug builds report it (FGR-20); IF it holds another control, or a group of controls inside it, THEN in debug builds THE checkbox group SHALL report it and SHALL make no entry of its value from what that one holds. THE checkbox group SHALL NOT restyle a checkbox or change how it answers hover, focus or a press (CHK-5 to CHK-10), and SHALL NOT set indeterminate on a checkbox of the set: a checkbox of the set is in the list or it is not. |
CKG-12 | WHILE selectAllLabel is not empty THE checkbox group SHALL bring one more checkbox, the select-all checkbox: the Checkbox component itself, labelled by selectAllLabel, placed before the first checkbox of the set as one more control of the field group — the same distance from the next, in a column or in a row, the set not indented under it — and so disabled and put in its error condition with the others (CKG-6, CKG-7). It SHALL stand for the checkboxes of the set that the product did not disable one by one: checked WHILE each of them is checked, indeterminate WHILE some are and some are not, unchecked WHILE none is (CHK-4), and disabled WHILE there is no such checkbox. It SHALL have no value, SHALL be no entry of the list, and SHALL follow every change of value and of the set at once, whoever made the change. WHILE selectAllLabel is empty THE checkbox group SHALL bring none. |
CKG-13 | WHEN the person activates the select-all checkbox while it is unchecked or indeterminate THE checkbox group SHALL check every checkbox of the set that the product did not disable itself, as CHK-2 says of an indeterminate checkbox, and while it is checked SHALL uncheck every one of them; a checkbox the product disabled SHALL stay as it is, and an entry of value that belongs to no checkbox SHALL stay in the list. THE checkbox group SHALL emit change exactly once, carrying the list after the change (CKG-4), and nothing of the select-all checkbox's own SHALL reach a listener on the group. |
CKG-14 | THE checkbox group SHALL add nothing of its own to how its members answer the layout direction, enlarged text and forced colors. WHERE the layout direction is right-to-left it SHALL be mirrored as the field group is (FGR-18), SHALL take its direction from where it is used and follow a change of it at once (FGR-19), keeping its value and its focus, and SHALL lay out each of its texts by that text's own direction (FGR-21), each checkbox mirroring itself (CHK-15, CHK-20, CHK-21); it has no key to exchange (CKG-5). WHILE the text size is enlarged it SHALL grow as the field group does (FGR-16): every text wraps, a row becomes a column where one line no longer holds two checkboxes, and the boxes keep their size. WHERE the platform draws with a person's own forced colors it SHALL be drawn as the field group is there (FGR-17), the error carried by the words of errorText and by each checkbox's invalid state, never by a color of the group's. |
CKG-15 | WHERE the platform has ARIA attributes (the web), WHEN the product sets an aria- attribute on the host, by the attribute or by the ARIA property that reflects it, THE checkbox group SHALL move it to the data-aria- attribute of the same name, so that the host is no second node with its name, description or state, and SHALL expose it on the group of the field group it is (CKG-9) — an id reference by the elements it names in the host's tree or a tree around it, a description after its own — except those the checkbox group owns (aria-label, aria-labelledby, aria-disabled, aria-required, aria-invalid, aria-errormessage), which it SHALL move and not expose: its name is label and its states are its props (CKG-9). WHEN the product removes the aria- attribute or its data-aria- twin, or sets the ARIA property that reflects it (ariaLabel, ariaDescribedByElements…) to null, THE checkbox group SHALL take it off that element. WHEN the product sets an aria- attribute the checkbox group owns THE checkbox group SHALL report it in debug builds. |
プラットフォーム別の名前対応
パリティは API が同一であることを意味しません。同じ契約を、各プラットフォームの流儀で表現します。
| 仕様 | Web | SwiftUI | Jetpack Compose | Flutter | React Native |
|---|---|---|---|---|---|
| コンポーネント | tanrei-checkbox-group | TanreiCheckboxGroup | TanreiCheckboxGroup | TanreiCheckboxGroup | CheckboxGroup |
value · プロパティ | value | selection | values | values | value |
label · プロパティ | label | label | label | labelText | label |
labelHidden · プロパティ | labelHidden | labelsHidden | labelHidden | labelHidden | labelHidden |
supportingText · プロパティ | supportingText | supportingText | supportingText | helperText | supportingText |
errorText · プロパティ | errorText | errorText | errorText | errorText | errorText |
error · プロパティ | error | error | isError | isError | error |
disabled · プロパティ | disabled | disabled | enabled | enabled | disabled |
required · プロパティ | required | isRequired | required | required | required |
optional · プロパティ | optional | isOptional | optional | optional | optional |
requiredMark · プロパティ | requiredMark | requiredMark | requiredMark | requiredMark | requiredMark |
requiredText · プロパティ | requiredText | requiredText | requiredText | requiredText | requiredText |
optionalText · プロパティ | optionalText | optionalText | optionalText | optionalText | optionalText |
orientation · プロパティ | orientation | orientation | orientation | orientation | orientation |
selectAllLabel · プロパティ | selectAllLabel | selectAllLabel | selectAllLabel | selectAllLabel | selectAllLabel |
change · イベント | change | selection | onValuesChange | onChanged | onValueChange |
| 備考 | <tanrei-checkbox-group label="Notify me by" name="notify"><tanrei-checkbox value="email" label="Email" checked></tanrei-checkbox>…</tanrei-checkbox-group>; class TanreiCheckboxGroup; in @tanrei/react, CheckboxGroup with value and onChange. Composed as every composed element on the web is (a custom element whose shadow root holds its members' own elements); what differs here: the members that hold the value are the product's own children. The shadow root holds one <tanrei-field-group spacing="controls"> — the member's own element, not drawing code shared with it — around, in this order, the select-all <tanrei-checkbox part="select-all"> while select-all-label is given, and a <slot>; the product's checkboxes stay in its light DOM and are assigned through the group's slot into the field group's. The eleven props that are the field group's are set on that element as they are given, and its documented parts are exported under its own names (exportparts); the group writes none of its custom properties, so --tanrei-comp-field-group-* set on the host is inherited by the field group inside. Name, description and states are the field group's own fieldset and legend, once: the host has no role. The field group gives disabled, the error condition and the error text to each checkbox by the tanrei-field-connect event it already answers — a slotted checkbox's event passes the field group on its composed path before it reaches the host, so the group forwards nothing. value is a property only, an array that is copied in and out; there is no value attribute, because the first value is written where HTML writes it, as checked on the children (CKG-3), and that is also what a reset returns to where the property was never set. A checkbox finds its group with closest('tanrei-checkbox-group') when it connects; the group's checkboxes are those among its descendants whose nearest checkbox group it is, found again when its child list changes. A checkbox inside a group fires no input and no change at all — stopped at the group they would still pass a capture listener on an ancestor — it tells its group, which sets value and fires input and one change, a bubbling CustomEvent whose detail.value is a copy of the list; a listener set on a checkbox inside a group hears nothing. A form-associated custom element (static formAssociated = true): name is a web attribute, not a spec prop; it submits a FormData of one entry per value under name (ElementInternals.setFormValue), restores the list on navigation (formStateRestoreCallback), follows <fieldset disabled>, and reports valueMissing while required and the list is empty, anchored on its first enabled checkbox, with the message errorText, else the required text (the instance's or the product's), else label — never a browser's sentence for one unchecked box. The host is not focusable and does not delegate focus; focus() moves to the first enabled checkbox. Attributes are kebab-case: label-hidden, supporting-text, error-text, required-mark, required-text, optional-text, select-all-label. The host is display: block. Without script the element is not defined and draws nothing of its own, as every Tanrei element with a shadow root; a page that must work without script writes a native fieldset of native checkboxes of one name, which submits the same entries. Words: the element has no words of its own; required-text and optional-text left empty read the product's words through the field group, and select-all-label is the instance's alone. | TanreiCheckboxGroup("Notify me by", selection: $channels, supportingText:, errorText:, error:, required:, optional:, orientation:, selectAllLabel:) { TanreiCheckbox("Email", value: Channel.email) … }, generic over a Hashable value: selection is a Binding<Set<V>>, and writing it is the change event; a set has no order to keep (CKG-4). The view is a TanreiFieldGroup around its content — the field group's own view, which reads comp.field-group from the environment, so one group is set apart with .tanreiTheme(_:) on it — and the checkboxes inside read and write the selection through the environment: TanreiCheckbox(_:value:) is the Checkbox with its isOn bound to membership. labelHidden follows .labelsHidden() and disabled follows .disabled(_:). The select-all checkbox is a TanreiCheckbox with isIndeterminate. No forms: CKG-8 does not apply. The product's words are read from the \.tanreiWords environment value. | TanreiCheckboxGroup(label = "Notify me by", values = channels, onValuesChange = { channels = it }, supportingText = …, isError = …, required = …, optional = …, orientation = …, selectAllLabel = …) { TanreiCheckbox(value = "email", label = "Email") … }: controlled, as Compose is — values is a Set<T>, the group calls onValuesChange and the caller moves it. The composable is a TanreiFieldGroup around its content, which runs in a TanreiCheckboxGroupScope whose TanreiCheckbox(value, label) is the Checkbox with checked and its click taken from the group; one group is set apart with a TanreiTheme around it. enabled is the inverse flag. The select-all checkbox is the TanreiCheckbox(state: ToggleableState, onClick) overload. No forms: CKG-8 does not apply. The product's words are read from LocalTanreiWords. | TanreiCheckboxGroup<T>(values:, onChanged:, labelText: 'Notify me by', helperText: …, errorText: …, isError: …, required: …, optional: …, orientation: …, selectAllLabel: …, children: [TanreiCheckbox<T>.inGroup(entry:, label:), …]): values is a Set<T>. The widget builds a TanreiFieldGroup around its children and an inherited scope that gives each checkbox its checked state and takes its change; one group is set apart with a TanreiTheme around it. enabled is the inverse flag. The select-all checkbox is a TanreiCheckbox with tristate. FormField integration is the product's: CKG-8 does not apply. The product's words are read from the TanreiWords inherited widget. | <CheckboxGroup label="Notify me by" value={channels} onValueChange={setChannels} supportingText="…" selectAllLabel="…"><Checkbox entry="email" label="Email" />…</CheckboxGroup>: controlled; value is an array of strings in the order of the checkboxes. The component renders a FieldGroup around its children and a context that gives each checkbox its checked state; one group is set apart with a provider around it. The select-all checkbox is a Checkbox with indeterminate. Follows the app's direction where an ancestor's is not known. No forms: CKG-8 does not apply. The product's words are read from the TanreiWordsProvider context. |
トークン
| トークン | 参照先 | 解決値（ライト） |
|---|---|---|
--tanrei-comp-field-group-error-text-gap | sys.space.space50 | 4px |
--tanrei-comp-field-group-field-min-width | — | 144px |
--tanrei-comp-field-group-gap-inline | sys.space.space200 | 16px |
--tanrei-comp-field-group-gap-controls | sys.space.space100 | 8px |
--tanrei-comp-field-group-gap-fields | sys.space.space300 | 24px |
--tanrei-comp-field-group-label-gap | sys.space.space100 | 8px |
--tanrei-comp-field-group-requirement-asterisk-gap | sys.space.space25 | 2px |
--tanrei-comp-field-group-requirement-gap | sys.space.space100 | 8px |
--tanrei-comp-field-group-requirement-mark | sys.behavior.requirement-mark | 0 |
--tanrei-comp-field-group-standard-disabled-error-text-color | — | |
--tanrei-comp-field-group-standard-disabled-error-label-color | — | |
--tanrei-comp-field-group-standard-disabled-error-required-asterisk-color | — | |
--tanrei-comp-field-group-standard-disabled-error-supporting-text-color | — | |
--tanrei-comp-field-group-standard-disabled-label-color | — | |
--tanrei-comp-field-group-standard-disabled-required-asterisk-color | — | |
--tanrei-comp-field-group-standard-disabled-supporting-text-color | — | |
--tanrei-comp-field-group-standard-error-text-color | sys.color.error | |
--tanrei-comp-field-group-standard-error-label-color | sys.color.on-surface | |
--tanrei-comp-field-group-standard-error-required-asterisk-color | sys.color.primary | |
--tanrei-comp-field-group-standard-error-supporting-text-color | sys.color.on-surface-variant | |
--tanrei-comp-field-group-standard-label-color | sys.color.on-surface | |
--tanrei-comp-field-group-standard-required-asterisk-color | sys.color.primary | |
--tanrei-comp-field-group-standard-supporting-text-color | sys.color.on-surface-variant | |
--tanrei-comp-field-group-supporting-text-gap | sys.space.space50 | 4px |
--tanrei-comp-field-group-label-typescale | sys.typescale.label | 500 14px/1.4286 |
--tanrei-comp-field-group-supporting-text-typescale | sys.typescale.label-small | 500 12px/1.3333 |
フィクスチャ
基準となる描画パターンです。全プラットフォームが同じ ID でスナップショットを撮り、結果を比較できるようにしています。
default
value: ["email"] label: Notify me by items: 3 supporting
value: ["email"] label: Notify me by supportingText: Choose all that apply. items: 3 label-hidden
value: ["email"] label: Notify me by labelHidden: true supportingText: Choose all that apply. items: 3 required
value: ["email"] label: Notify me by supportingText: Choose all that apply. required: true requiredText: Required items: 3 optional
label: Notify me by optional: true optionalText: Optional items: 3 required-asterisk
value: ["email"] label: Notify me by required: true requiredMark: asterisk requiredText: Required items: 3 required-error
label: Notify me by supportingText: Choose all that apply. errorText: Choose at least one way to reach you. error: true required: true requiredText: Required items: 3 horizontal
value: ["email"] label: Notify me by orientation: horizontal items: 3 horizontal-many
value: ["mon","tue","wed","thu","fri"] label: Days supportingText: The days the report is sent. orientation: horizontal items: 10 disabled
value: ["email"] label: Notify me by supportingText: Choose all that apply. disabled: true required: true requiredText: Required items: 3 one-disabled
value: ["email"] label: Notify me by items: 3 long-label
label: Which of these ways may we use to reach… supportingText: Choose all that apply. We use the first… errorText: Choose at least one way to reach you, or… error: true required: true requiredText: Required items: 3 required-ja
value: ["email"] label: 連絡方法 supportingText: 当てはまるものをすべて選んでください。 required: true requiredText: 必須 items: 3 rtl
value: ["email"] label: طرق الإشعار supportingText: اختر كل ما ينطبق. required: true requiredText: مطلوب direction: rtl items: 3 horizontal-rtl
label: ימים errorText: יש לבחור יום אחד לפחות. error: true orientation: horizontal direction: rtl items: 3 ltr-label-rtl
value: ["2.4","5"] label: Wi-Fi 6E supportingText: 2.4 GHz, 5 GHz, 6 GHz direction: rtl items: 3 error-selected
value: ["text"] label: Notify me by supportingText: Choose all that apply. errorText: This number cannot receive text messages… error: true required: true requiredText: Required items: 3 select-all-none
label: Notify me by selectAllLabel: All of these items: 3 select-all-some
value: ["email"] label: Notify me by selectAllLabel: All of these items: 3 select-all-all
value: ["email","text","push"] label: Notify me by selectAllLabel: All of these items: 3 select-all-one-disabled
value: ["email","push"] label: Notify me by selectAllLabel: All of these items: 3 生成元 specs/checkbox-group.spec.json, tokens/comp/field-group.tokens.json, design/tokens/
- 要素のシャドウルートにあるのは
<tanrei-field-group>で、その中に、select-all-labelを指定している間のすべてにチェックを入れるチェックボックスと、スロットがあります。チェックボックスは利用者側の子要素のままです。要素をインポートすると、2 つの構成要素も定義されます。 valueはプロパティだけで、配列を写して出し入れします。value属性はありません。属性にリストを書くには、値に含まれるかもしれない区切りが必要になり、HTML にはすでに、子ごとのcheckedという書き方があるためです。value属性がなく、値も設定されていないチェックボックスには、値がありません。単独のチェックボックスが送信する「on」は、グループの中では読まれません。未チェックで描かれ、デバッグビルドが知らせます。- 要素はフォームに関連付けられます。
nameとformを受け取り、値ごとに 1 つの項目をnameで送信します。同じ名前を持つ素のチェックボックスが送信するものと同じです。チェックボックスは、どんなnameを持っていても何も送信しません。リセットすると最初の値に戻り、無効な<fieldset>に従い、requiredが設定されていてリストが空の間は、値がないことを報告します。メッセージはerror-text、なければ必須のテキスト、それもなければlabelです。error-textは、errorを設定するときだけでなく、最初から指定してください。 changeは CustomEvent で、detail.valueはリストの写しです。その前にinputが発生します。グループの中のチェックボックスに付けたリスナーには、どちらも届きません。- パーツ:
field-groupが枠で、そのパーツは 1 つ下の階層と同じ名前です。label、requirement-label、supporting-text、error-textです。select-allがすべてにチェックを入れるチェックボックスで、そのパーツはselect-all-container、select-all-box、select-all-mark、select-all-labelです。利用者側のチェックボックスは、ほかの場所と同じくtanrei-checkbox::part(…)でスタイルを変えます。 - 要素そのものはフォーカスを受け取りません。
focus()は最初の有効なチェックボックスに移り、ページの<label for>もフォーカスをそこに移します。 - 要素にロールはありません。名前は
labelで付けます。ラベルが別の場所に描かれているときはlabel-hiddenを併せて指定します。aria-labelはここでは何にも名前を付けないので、使いません。 - 属性はケバブケースです。
label-hidden、supporting-text、error-text、required-mark、required-text、optional-text、select-all-labelです。 - 要素が定義されるまでと、スクリプトがないときは、要素自身のものは何も描かれず、チェックボックスがそのままの内容として表示されます。スクリプトなしで動く必要があるページでは、同じ
nameを持つ素のチェックボックスを素の<fieldset>に入れます。送信される項目は同じです。
- ラベルは質問として、各チェックボックスのラベルはその答えの 1 つとして書きます。
- 答え方は
supportingTextで伝えます。「当てはまるものをすべて選んでください。」などです。 - 縦の並びを優先します。横の並びは、短いラベルが少しだけのときに使います。
- 必須にするときは、
errorTextも一緒に指定します。フォーム自身の検証が、利用者側の言葉で伝えられるようになります。 - すべてにチェックを入れるチェックボックスは、6 つ以上の集まり、絞り込み、権限の集まりで使います。
- いくつかの選択肢から 1 つを選ぶ答えに、チェックボックスグループを使わないでください。それはラジオグループです。
- 送信するために、チェックボックスに
nameを付けないでください。グループが自分の名前でリストを送信します。 - チェックボックスでない、操作できるものを中に入れないでください。デバッグビルドが知らせ、その値がリストの項目になることもありません。
- 階層を示すために、すべてにチェックを入れるチェックボックスの下で集まりを字下げしないでください。選択肢の中の選択肢は、ツリーです。
aria-labelでグループに名前を付けないでください。ラベルを描きたくないときは、labelとlabelHiddenを指定します。
- ロール
group- ラベル付け
- label names the group, drawn or not (labelHidden). Each checkbox keeps its own name, its own label beside it; the select-all checkbox is named by selectAllLabel. The group's description is the field group's: supportingText, then errorText while error is true, then requiredText while the group is required, then optionalText while it is optional (FGR-11). A group has no required and no invalid state: the requirement is said in the product's words, and each checkbox of a group in error is exposed as invalid and described by errorText. How many are checked is not said unless the product writes it in supportingText.
- 最小ターゲット
- 見た目のサイズが小さくても、ヒット領域は最小ターゲットサイズを満たします。 minimum 32px · pointer 44px · spacing 8px · touch 48px
キーボード操作
| キー | 動作 |
|---|---|
| Tab / Shift+Tab | Moves focus to each enabled checkbox of the set in the order given — the select-all checkbox first where there is one — and out of the group. Every checkbox is a stop; the group is not (CKG-5). |
| Space | Switches the focused checkbox (CHK-1); on the select-all checkbox, checks every enabled checkbox of the set, or unchecks them all where all were checked (CKG-13). |
| Arrow keys | Nothing: a set of checkboxes has no arrow keys on any platform, because moving among them must not change them and each is a stop already. |
| Enter | Nothing on the web, where it submits the form; switches the focused checkbox where the platform activates any focused control with Enter (Android, tvOS), as CHK-1 says. |
備考
- Not a target itself: the group takes no press and is not a focus stop (CKG-5), so minimumTarget holds through its checkboxes, each of which keeps a whole touch target of its own at the distance the field group puts between them (CHK-7, FGR-3).
- The checkbox group is a field group of checkboxes that owns their value (composed: the field group frames it, its checkboxes hold its value). What it adds to the two is what every product otherwise writes: the list of checked values and one change for it, one name in a form with reset and the form's own check that a required set is not empty, and the select-all checkbox's three states. It adds no look and has no tokens of its own.
- One level down is always open: a field group around checkboxes, each checked by the product, is the same picture, the same group, the same names, descriptions and states. Take it where each checkbox must have a name of its own in the form, where the set holds something that is not a checkbox, or where the product wants its own rule for what "all" means.
- Beside the radio group. A radio group has one answer, so it is one stop in the focus order, its arrow keys move and select, and its role has a required and an invalid state. A checkbox group has a list: every checkbox is a stop and Space switches it, there are no arrow keys, and its role is the plain group's — the requirement is said in words and each checkbox says invalid for itself. A radio group in error leaves its rings as they are; a checkbox group in error marks every box, because a checkbox has an error condition and a radio button has none.
- required means "at least one". A least or a greatest number of choices ("choose up to three") is the product's rule: it reads the length of the list in change, sets error and writes errorText with the number in its own words, or disables what may no longer be chosen. The group knows no number, because it would have no words to say it with.
- The select-all checkbox stands for the checkboxes the group holds and a person can switch, never for choices the product has not given it. It is one more stop before the set. It is not the place for a hierarchy: choices inside choices are a tree.
- A disabled group is not submitted; a checkbox disabled by itself in an enabled group keeps its entry in the value and is submitted with it. A choice that is always on ("Email, required for your account") is therefore one disabled, checked checkbox, and needs no hidden field beside it.
- When a checkbox group, and when something else. Several of a few choices that are all worth seeing at once, in a form or a setting: a checkbox group, of up to about seven. One of a few: a radio group. One thing on or off, on its own: a checkbox, or a switch where it takes effect at once. Several of many, or where there is little room: a list with multiple selection, or a select. Rows of a table chosen for an action: the table's own selection. Things on or off that are not one answer — each with a name of its own in the form — or a set of switches: a field group.
- On the web the group's shadow root holds the field group's own element around a slot, and the checkboxes stay the product's children: the group is the field group's `fieldset` with its `legend`, exposed once.
- Heights are the texts' and the checkboxes': at 200% text size every text wraps, a row becomes a column, and nothing is cut (WCAG 1.4.4, 1.4.10).
- How a state looks is a value decision of the active design system; components read the state's tokens and never compute the effect themselves.
生成元 specs/checkbox-group.spec.json, tokens/sys/measure.tokens.json
- フィールドグループの、チェックボックスを含む 1 つのグループです。名前は
labelで、描かれていてもいなくても変わりません。説明は、説明のテキスト、エラーの間はエラーのテキスト、そしてプロダクトの言葉で書かれた必須または任意のテキストです。 - グループには、必須の状態も invalid の状態もありません。必須かどうかは言葉で伝わり、エラーのグループのチェックボックスは、それぞれが invalid として伝わり、エラーのテキストが説明になります。
- 各チェックボックスは、自分のロール、名前、チェックの状態を保ちます。すべてにチェックを入れるチェックボックスは、一部にチェックが入っている間、中間状態を伝えます。集まりの中での位置を伝えるチェックボックスはなく、いくつにチェックが入っているかも伝わりません。
- 有効なチェックボックスは、どれも Tab でフォーカスが止まる位置です。すべてにチェックを入れるチェックボックスが最初です。Space は、フォーカスのあるチェックボックスを切り替えます。矢印キーはなく、Enter はフォームに任せます。
- ラベル、必須または任意の印、説明、エラーのテキストを押しても、チェックは入らず、フォーカスも動きません。
- フォーカスがチェックボックスの 1 つにある間に現れたエラーは、フィールドグループが 1 回だけ、控えめに読み上げます。
- 書字方向、文字の拡大、強制カラーには、構成要素がそれぞれ応えます。右から左へのレイアウトでは、枠と各チェックボックスの左右が入れ替わります。文字を 200% にすると、どのテキストも折り返し、横の並びは縦の並びになり、横にスクロールすることはありません。
- 自分の言葉は持ちません。
requiredTextとoptionalTextを空にすると、フィールドグループがプロダクトの言葉から読みます。
Web での既知の不足: スクリーンリーダーがグループについて何を読むかは、ブラウザーのアクセシビリティツリーから読んだもので、スクリーンリーダーで聞いて確かめてはいません。Chromium は、フォームがこの要素を検証するため、アクセシビリティツリーの中でこの要素に自分のノードを与えます。ロールも名前もないノードで、グループを囲みます。
labelを必ず指定し、すべてのチェックボックスにもlabelを指定します。- グループが必須または任意のときは、
requiredTextとoptionalTextを、グループに、またはプロダクトに 1 回、指定します。グループには必須の状態がないので、それを伝えるのは言葉です。 - 何が間違っているか、どう直せばよいかを
errorTextで伝えます。色だけを手がかりにしません。 - 選んだ数が意味を持つとき（「5 つのうち 2 つを選択」など）は、
supportingTextに書きます。そうしなければ、読み上げられません。