Skip to content

Commit 5ef4dc1

Browse files
authored
docs(radio-button): use name in examples (#1817)
1 parent 9456eaa commit 5ef4dc1

File tree

2 files changed

+23
-24
lines changed

2 files changed

+23
-24
lines changed

docs/src/pages/components/RadioButton.svx

+14-20
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,21 @@ components: ["RadioButtonGroup", "RadioButton", "RadioButtonSkeleton"]
99

1010
## Default
1111

12-
<RadioButtonGroup selected="standard">
12+
The `name` prop set on `RadioButtonGroup` is passed to the individual `RadioButton` inputs.
13+
14+
<RadioButtonGroup legendText="Storage tier (disk)" name="plan" selected="standard">
1315
<RadioButton labelText="Free (1 GB)" value="free" />
1416
<RadioButton labelText="Standard (10 GB)" value="standard" />
1517
<RadioButton labelText="Pro (128 GB)" value="pro" />
1618
</RadioButtonGroup>
1719

18-
## With legend text
20+
## Hidden legend
21+
22+
It's recommended that you provide a legend for accessibility.
23+
24+
Use `hideLegend` to visually hide the legend text.
1925

20-
<RadioButtonGroup legendText="Storage tier (disk)" selected="standard">
26+
<RadioButtonGroup hideLegend legendText="Storage tier (disk)" selected="standard">
2127
<RadioButton labelText="Free (1 GB)" value="free" />
2228
<RadioButton labelText="Standard (10 GB)" value="standard" />
2329
<RadioButton labelText="Pro (128 GB)" value="pro" />
@@ -27,8 +33,8 @@ components: ["RadioButtonGroup", "RadioButton", "RadioButtonSkeleton"]
2733

2834
Use the named "legendText" slot to customize the legend text.
2935

30-
<RadioButtonGroup selected="standard">
31-
<div slot="legendText" style="display: flex">
36+
<RadioButtonGroup name="plan" selected="standard">
37+
<div slot="legendText" style:display="flex">
3238
Storage tier (disk)
3339
<Tooltip>
3440
<p>
@@ -41,18 +47,6 @@ Use the named "legendText" slot to customize the legend text.
4147
<RadioButton labelText="Pro (128 GB)" value="pro" />
4248
</RadioButtonGroup>
4349

44-
## Hidden legend
45-
46-
It's recommended that you provide a legend for accessibility.
47-
48-
Use `hideLegend` to visually hide the legend text.
49-
50-
<RadioButtonGroup hideLegend legendText="Storage tier (disk)" selected="standard">
51-
<RadioButton labelText="Free (1 GB)" value="free" />
52-
<RadioButton labelText="Standard (10 GB)" value="standard" />
53-
<RadioButton labelText="Pro (128 GB)" value="pro" />
54-
</RadioButtonGroup>
55-
5650
## Reactive example
5751

5852
Use the `selected` prop to bind and update the selected value.
@@ -61,23 +55,23 @@ Use the `selected` prop to bind and update the selected value.
6155

6256
## Left-aligned label text
6357

64-
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" selected="standard">
58+
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" name="plan" selected="standard">
6559
<RadioButton labelText="Free (1 GB)" value="free" />
6660
<RadioButton labelText="Standard (10 GB)" value="standard" />
6761
<RadioButton labelText="Pro (128 GB)" value="pro" />
6862
</RadioButtonGroup>
6963

7064
## Disabled buttons
7165

72-
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" selected="standard">
66+
<RadioButtonGroup labelPosition="left" legendText="Storage tier (disk)" name="plan" selected="standard">
7367
<RadioButton disabled labelText="Free (1 GB)" value="free" />
7468
<RadioButton labelText="Standard (10 GB)" value="standard" />
7569
<RadioButton disabled labelText="Pro (128 GB)" value="pro" />
7670
</RadioButtonGroup>
7771

7872
## Vertical orientation
7973

80-
<RadioButtonGroup orientation="vertical" legendText="Storage tier (disk)" selected="standard">
74+
<RadioButtonGroup orientation="vertical" legendText="Storage tier (disk)" name="plan" selected="standard">
8175
<RadioButton labelText="Free (1 GB)" value="free" />
8276
<RadioButton labelText="Standard (10 GB)" value="standard" />
8377
<RadioButton labelText="Pro (128 GB)" value="pro" />

docs/src/pages/framed/RadioButton/RadioButtonReactive.svelte

+9-4
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,20 @@
1010
let plan = plans[1];
1111
</script>
1212

13-
<RadioButtonGroup legendText="Storage tier (disk)" bind:selected="{plan}">
14-
{#each plans as value}
13+
<RadioButtonGroup
14+
legendText="Storage tier (disk)"
15+
name="plan"
16+
bind:selected="{plan}"
17+
>
18+
{#each plans as value (value)}
1519
<RadioButton labelText="{value}" value="{value}" />
1620
{/each}
1721
</RadioButtonGroup>
1822

19-
<div style="margin: var(--cds-layout-01) 0">
20-
{#each plans as value}
23+
<div style="margin: var(--cds-layout-03) 0">
24+
{#each plans as value (value)}
2125
<Button
26+
size="small"
2227
kind="secondary"
2328
disabled="{plan === value}"
2429
on:click="{() => (plan = value)}"

0 commit comments

Comments
 (0)