Radio Group
- HTML/CSS:Dev Ready
- Layout:Desktop Only
A select list that can have a single entry checked at any one time.
Base
Preview
About Radio Group
Radio buttons are shown in a group of two or more. The user can only select
one radio button at a time. You should use the same name attribute on all
radio buttons in the group. This ensures that if there is more than one
group in the form, each one stays associated with its own group.
The ability to style radio buttons with CSS varies across browsers. To ensure that radio buttons look the same everywhere, we use a custom DOM. Pay close attention to the markup, because all elements must exist for the styles to work.
Accessibility
Groups of radio buttons should be marked up using the fieldset and legend element. This helps someone using assistive technology to understand the question they're answering with the group of radio buttons. The fieldset is placed around the whole group and the legend contains the question.
Custom radio buttons are created by applying the .slds-radio class to a
<label> element. To remain accessible to all user agents, place an
<input> with type="radio" inside the <label> element. The <input>
is then visually hidden, and the styling is placed on a span with the
.slds-radio_faux class. The styling of the span changes based on whether
the radio button is selected or focused by using a pseudo-element. A second
span with .slds-form-element__label contains the label text.
When a radio group is required, the <fieldset> should receive the class
.slds-is-required. The <legend> should then get
<abbr class="required" title="required">*</abbr> added to the DOM for
visual indication that the radio group is required.
When disabling a radio button, either the entire group must be disabled or if only some radio buttons are disabled, then the checked radio button cannot be disabled.
Overview of CSS Classes
- Selector
- The CSS class being referred to.
- Summary
- A description of what the class does.
- Support
- Whether the class name is dev-ready (meaning it's fully vetted and tested and safe to use) or prototype (which means it's not fully vetted yet).
- Restrict
- The selector that the class name is allowed to be used on.
- Variant
- The base level pattern for a component. A variant can be extended to create another variant of that component, for example, a stateful button is a derivative of the base button.
- Modifier
- A single class that can be added to an HTML element of a component to modify its output. Typically these will be colors, sizing and positioning.
| Selector | .slds-radio |
|---|---|
| Summary | Initializes radio button |
| Support | dev-ready |
| Restrict | span |
| Variant | True |