Skip to content

Add Toggle layout examples to guidelines #3340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 4, 2025
Merged

Add Toggle layout examples to guidelines #3340

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
52fe788
Added example image of the Toggle and required/optional content
jorytindall Oct 31, 2025
ae82443
Added layout examples to guidelines
jorytindall Oct 31, 2025
10c1f32
Remove unnecessary image
jorytindall Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions website/docs/components/form/toggle/partials/guidelines/guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,37 @@
- When users need to select more than one option from a list, consider [Checkbox](/components/form/checkbox).
- When only one choice can be selected, consider [Radio](/components/form/radio) buttons.

## Layout

We recommend using vertical Toggle groups, especially with short option lists.

<Doc::Layout @spacing="48px">
<Hds::Form::Toggle::Group @layout="vertical" as |G|>
<G.Legend>Vertical group</G.Legend>
<G.ToggleField name="demo-group-option-1" @@id="group-option-1" as |F|>
<F.Label>Option 1</F.Label>
</G.ToggleField>
<G.ToggleField name="demo-group-option-2" @id="group-option-2" as |F|>
<F.Label>Option 2</F.Label>
</G.ToggleField>
<G.ToggleField name="demo-group-option-3" @id="group-option-3" as |F|>
<F.Label>Option 3</F.Label>
</G.ToggleField>
</Hds::Form::Toggle::Group>
<Hds::Form::Toggle::Group @layout="horizontal" as |G|>
<G.Legend>Horizontal group</G.Legend>
<G.ToggleField name="demo-group-option-1" @id="group-option-1" as |F|>
<F.Label>Option 1</F.Label>
</G.ToggleField>
<G.ToggleField name="demo-group-option-2" @id="group-option-2" as |F|>
<F.Label>Option 2</F.Label>
</G.ToggleField>
<G.ToggleField name="demo-group-option-3" @id="group-option-3" as |F|>
<F.Label>Option 3</F.Label>
</G.ToggleField>
</Hds::Form::Toggle::Group>
</Doc::Layout>

## Error validation

For error validation recommendations, refer to the [Form patterns](/patterns/form-patterns?tab=validation) documentation.