sp-radio

Examples API

Attributes and Properties #

Property Attribute Type Default Description
autofocus autofocus boolean false When this control is rendered, focus it automatically
checked checked boolean false Represents when the input is checked
dir dir 'ltr' | 'rtl' 'ltr'
disabled disabled boolean false Uses the disabled style
emphasized emphasized boolean false
invalid invalid boolean false Uses the invalid style
undefined label-below Moves the label below the radio button
readonly readonly boolean false
value value string '' Identifies this radio button within its radio group

Slots #

Name Description
default slot text label of the Radio button

Events #

Name Type Description
change Event When the input is interacted with and its state is changed

CSS Custom Properties #

Name Default
--spectrum-alias-focus-ring-gap var(--spectrum-global-dimension-static-size-25)
--spectrum-radio-m-circle-background-color var(--spectrum-global-color-gray-75)
--spectrum-radio-m-circle-border-color var(--spectrum-alias-toggle-border-color-default)
--spectrum-radio-m-circle-border-color-disabled var(--spectrum-global-color-gray-400)
--spectrum-radio-m-circle-border-color-down var(--spectrum-alias-toggle-border-color-down)
--spectrum-radio-m-circle-border-color-hover var(--spectrum-alias-toggle-border-color-hover)
--spectrum-radio-m-circle-border-color-key-focus var(--spectrum-alias-toggle-border-color-key-focus)
--spectrum-radio-m-circle-border-color-selected var(--spectrum-alias-toggle-background-color-default)
--spectrum-radio-m-circle-border-color-selected-down var(--spectrum-alias-toggle-background-color-down)
--spectrum-radio-m-circle-border-color-selected-hover var(--spectrum-alias-toggle-background-color-hover)
--spectrum-radio-m-circle-border-color-selected-key-focus var(--spectrum-alias-toggle-background-color-key-focus)
--spectrum-radio-m-circle-border-size var(--spectrum-alias-border-size-thick)
--spectrum-radio-m-circle-diameter var(--spectrum-alias-control-two-size-m)
--spectrum-radio-m-circle-dot-size var(--spectrum-global-dimension-static-size-50)
--spectrum-radio-m-emphasized-circle-border-color-error var(--spectrum-global-color-red-500)
--spectrum-radio-m-emphasized-circle-border-color-error-hover var(--spectrum-global-color-red-600)
--spectrum-radio-m-emphasized-circle-border-color-selected var(--spectrum-alias-toggle-background-color-emphasized-selected-default)
--spectrum-radio-m-emphasized-circle-border-color-selected-down var(--spectrum-alias-toggle-background-color-emphasized-selected-down)
--spectrum-radio-m-emphasized-circle-border-color-selected-hover var(--spectrum-alias-toggle-background-color-emphasized-selected-hover)
--spectrum-radio-m-emphasized-circle-border-color-selected-key-focus var(--spectrum-alias-toggle-background-color-emphasized-selected-key-focus)
--spectrum-radio-m-emphasized-text-color-error var(--spectrum-alias-component-text-color-error-default)
--spectrum-radio-m-emphasized-text-color-error-down var(--spectrum-alias-component-text-color-error-down)
--spectrum-radio-m-emphasized-text-color-error-hover var(--spectrum-alias-component-text-color-error-hover)
--spectrum-radio-m-focus-ring-color-key-focus var(--spectrum-alias-focus-ring-color)
--spectrum-radio-m-focus-ring-size var(--spectrum-alias-focus-ring-size)
--spectrum-radio-m-height var(--spectrum-global-dimension-size-400)
--spectrum-radio-m-text-color var(--spectrum-alias-component-text-color-default)
--spectrum-radio-m-text-color-disabled var(--spectrum-alias-component-text-color-disabled)
--spectrum-radio-m-text-color-down var(--spectrum-alias-component-text-color-down)
--spectrum-radio-m-text-color-hover var(--spectrum-alias-component-text-color-hover)
--spectrum-radio-m-text-font-style var(--spectrum-global-font-style-regular)
--spectrum-radio-m-text-font-weight var(--spectrum-alias-body-text-font-weight)
--spectrum-radio-m-text-gap var(--spectrum-global-dimension-size-125)
--spectrum-radio-m-text-line-height var(--spectrum-alias-component-text-line-height)
--spectrum-radio-m-text-size var(--spectrum-global-dimension-font-size-100)

Description #

<sp-radio> and <sp-radio-group> allow users to select a single option from a list of mutually exclusive options. All possible options are exposed up front for users to compare.

<sp-radio-group> holds a list of <sp-radio> elements, and is responsible for deselecting radio buttons when a new one is selected, which in turn makes it responsible for keeping track of which one is selected. <sp-radio> is responsible for handling user interactions and for visually reflecting if it is the one that is checked or not.

Usage #

See it on NPM! How big is this package in your project? Try it on webcomponents.dev

yarn add @spectrum-web-components/radio

Import the side effectful registration of <sp-radio> or <sp-radio-group> via:

import '@spectrum-web-components/radio/sp-radio.js';
import '@spectrum-web-components/radio/sp-radio-group.js';

When looking to leverage the Radio or RadioGroup base classes as a type and/or for extension purposes, do so via:

import {
    Radio,
    RadioGroup
} from '@spectrum-web-components/radio';

Example #

<sp-radio-group selected="first" name="example">
<sp-radio value="first">Option 1</sp-radio>
<sp-radio value="second">Option 2</sp-radio>
<sp-radio value="third">Option 3</sp-radio>
<sp-radio value="fourth">Option 4</sp-radio>
</sp-radio-group>

Standard radio buttons #

Standard radio buttons are the default style for radio buttons. They are optimal for application panels where all visual elements are monochrome in order to direct focus to the content.

<div style="display: flex; justify-content: space-between;">
<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Default</h4>
<sp-radio-group name="example" vertical>
<sp-radio value="kittens">Kittens</sp-radio>
<sp-radio value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>

<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Invalid</h4>
<sp-radio-group name="example" vertical>
<sp-radio invalid value="kittens">Kittens</sp-radio>
<sp-radio invalid value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>

<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Disabled</h4>
<sp-radio-group name="example" vertical>
<sp-radio disabled value="kittens">Kittens</sp-radio>
<sp-radio disabled value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>
</div>

Emphasized radio buttons #

Emphasized radio buttons are a secondary style for radio buttons. The blue color provides a visual prominence that is optimal for forms, settings, etc. where the radio buttons need to be noticed.

<div style="display: flex; justify-content: space-between;">
<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Default</h4>
<sp-radio-group name="example" vertical>
<sp-radio emphasized value="kittens">Kittens</sp-radio>
<sp-radio emphasized value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>

<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Invalid</h4>
<sp-radio-group name="example" vertical>
<sp-radio emphasized invalid value="kittens">Kittens</sp-radio>
<sp-radio emphasized invalid value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>

<div style="display: flex; flex-direction: column;">
<h4 class="spectrum-Heading--subtitle1">Disabled</h4>
<sp-radio-group name="example" vertical>
<sp-radio emphasized disabled value="kittens">Kittens</sp-radio>
<sp-radio emphasized disabled value="puppies" checked>Puppies</sp-radio>
</sp-radio-group>
</div>
</div>

Label Below #

<sp-radio label-below>A label</sp-radio>

Wrapping behavior #

<sp-radio label-below>
Radio with an extraordinarily long label please don't do this but if you did
it should wrap text when it gets longer than the container which contains
the radio which has an unacceptably long label
</sp-radio>

Handling events #

Event handlers for clicks and other user actions can be registered on an <sp-radio> similar to a standard <input type="radio"> element.

<sp-radio id="radio-example" onclick="spAlert(this, '<sp-radio> clicked!')">
Web component
</sp-radio>

Help text #

Help text can be accessibly associated with an <sp-radio-group> element by using the help-text or negative-help-text slots. When using the negative-help-text slot, <sp-radio-group> will self manage the presence of this content based on the value of the invalid property on your <sp-radio-group> element. Content within the help-text slot will be show by default. When your <sp-radio-group> should receive help text based on state outside of the complexity of invalid or not, manage the content addressed to the help-text from above to ensure that it displays the right messaging and possesses the right variant.

Self managed
<sp-field-label for="self">
What is your favorite ice cream flavor?
</sp-field-label>
<sp-radio-group
is="self"
onchange="
this.invalid = this.selected === 'fourth';
"

>

<sp-radio value="first">Vanilla</sp-radio>
<sp-radio value="second">Chocolate</sp-radio>
<sp-radio value="third">Strawberry</sp-radio>
<sp-radio value="fourth">I don't like ice cream</sp-radio>
<sp-help-text slot="help-text">Everyone likes ice cream.</sp-help-text>
<sp-help-text slot="negative-help-text" icon>
You can't not like ice cream.
</sp-help-text>
</sp-radio-group>
Managed from above
<sp-field-label for="managed">
What is your favorite ice cream flavor?
</sp-field-label>
<sp-radio-group
is="managed"
onchange="
const helpText = this.querySelector(`[slot='help-text']`);
const isInvalid = this.selected === 'fourth';
helpText.icon = isInvalid;
helpText.textContent = isInvalid ? 'You can\'t not like ice cream.' : 'Everyone likes ice cream.';
helpText.variant = isInvalid ? 'negative' : 'neutral';
"

>

<sp-radio value="first">Vanilla</sp-radio>
<sp-radio value="second">Chocolate</sp-radio>
<sp-radio value="third">Strawberry</sp-radio>
<sp-radio value="fourth">I don't like ice cream</sp-radio>
<sp-help-text slot="help-text">Everyone likes ice cream.</sp-help-text>
</sp-radio-group>

Accessibility #

Radio buttons are accessible by default, rendered in HTML using the <input type="radio"> element. Tabbing into a group of radio buttons places the focus on the first radio button selected. If none of the radio buttons are selected, the focus is set on the first one in the group. Space selects the radio button in focus (if not already selected). Using the arrow keys moves focus and selection to the previous or next radio button in the group (last becomes first, and first becomes last). The new radio button in focus gets selected even if the previous one was not.