Radio Group

<cs-radio-group>

Stable

Since 0.1

Radio groups wrap a set of radios so they function as a single form control with one shared value. They handle keyboard navigation, labeling, and validation for the group as a whole.

  Light roast
  Medium roast
  Dark roast

<cs-radio-group label="Coffee roast" name="roast" value="medium">
  <cs-radio value="light">Light roast</cs-radio>
  <cs-radio value="medium">Medium roast</cs-radio>
  <cs-radio value="dark">Dark roast</cs-radio>
</cs-radio-group>

Examples

Initial Value

Use the value attribute on the radio group to set the initially selected radio. Match it to the value of the radio that should start checked, just like native HTML.

  Light roast
  Medium roast
  Dark roast

<cs-radio-group label="Coffee roast" name="roast" value="dark">
  <cs-radio value="light">Light roast</cs-radio>
  <cs-radio value="medium">Medium roast</cs-radio>
  <cs-radio value="dark">Dark roast</cs-radio>
</cs-radio-group>

To target checked radios with CSS, use the :state(checked) selector.

Hint

Add descriptive hint to a radio group with the hint attribute. For hints that contain HTML, use the hint slot instead.

  Light roast
  Medium roast
  Dark roast

<cs-radio-group label="Coffee roast" hint="Pick the roast we'll grind for your order." name="roast" value="medium">
  <cs-radio value="light">Light roast</cs-radio>
  <cs-radio value="medium">Medium roast</cs-radio>
  <cs-radio value="dark">Dark roast</cs-radio>
</cs-radio-group>

Radio Buttons

Set the appearance attribute to button on all radios to render a radio button group.

  
    Light
    Dark
    Auto
  
    Light
    Dark
    Auto

<div class="cs-stack">
  <cs-radio-group
    label="Color scheme"
    hint="Choose how the interface should appear."
    orientation="horizontal"
    name="scheme"
    value="auto"
  >
    <cs-radio appearance="button" value="light">Light</cs-radio>
    <cs-radio appearance="button" value="dark">Dark</cs-radio>
    <cs-radio appearance="button" value="auto">Auto</cs-radio>
  </cs-radio-group>

  <cs-radio-group
    label="Color scheme"
    hint="Choose how the interface should appear."
    orientation="vertical"
    name="scheme"
    value="auto"
    style="max-width: 300px;"
  >
    <cs-radio appearance="button" value="light">Light</cs-radio>
    <cs-radio appearance="button" value="dark">Dark</cs-radio>
    <cs-radio appearance="button" value="auto">Auto</cs-radio>
  </cs-radio-group>
</div>

Disabled

To disable the entire radio group, add the disabled attribute to the radio group.

  Standard
  Express
  Overnight

<cs-radio-group label="Shipping speed" disabled>
  <cs-radio value="standard">Standard</cs-radio>
  <cs-radio value="express">Express</cs-radio>
  <cs-radio value="overnight">Overnight</cs-radio>
</cs-radio-group>

To disable individual options, add the disabled attribute to the respective options.

  Standard
  Express
  Overnight

<cs-radio-group label="Shipping speed">
  <cs-radio value="standard">Standard</cs-radio>
  <cs-radio value="express">Express</cs-radio>
  <cs-radio value="overnight" disabled>Overnight</cs-radio>
</cs-radio-group>

Orientation

The default orientation for radio items is vertical. Set the orientation to horizontal to lay items out on the same row.

  Standard
  Express
  Overnight

<cs-radio-group
  label="Shipping speed"
  hint="Choose how fast you'd like your order."
  orientation="horizontal"
  name="shipping"
  value="standard"
>
  <cs-radio value="standard">Standard</cs-radio>
  <cs-radio value="express">Express</cs-radio>
  <cs-radio value="overnight">Overnight</cs-radio>
</cs-radio-group>

Size

The size of radios will be determined by the Radio Group’s size attribute.

  
    Light roast
    Medium roast
    Dark roast
  
  
    Light roast
    Medium roast
    Dark roast
  
  
    Light roast
    Medium roast
    Dark roast
  
  
    Light roast
    Medium roast
    Dark roast
  
  
    Light roast
    Medium roast
    Dark roast
  

<div class="cs-stack">
  <cs-radio-group label="Extra small" size="xs" value="medium">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <cs-radio-group label="Small" size="s" value="medium">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <cs-radio-group label="Medium" size="m" value="medium">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <cs-radio-group label="Large" size="l" value="dark">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <cs-radio-group label="Extra large" size="xl" value="dark">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
</div>

If you need to have radios of varying sizes, place the size attribute on individual radio items instead.

  Extra Small
  Small
  Medium
  Large
  Extra Large

<cs-radio-group label="Mixed sizes" value="m">
  <cs-radio value="xs" size="xs">Extra Small</cs-radio>
  <cs-radio value="s" size="s">Small</cs-radio>
  <cs-radio value="m" size="m">Medium</cs-radio>
  <cs-radio value="l" size="l">Large</cs-radio>
  <cs-radio value="xl" size="xl">Extra Large</cs-radio>
</cs-radio-group>

Validation

Set the required attribute to make selecting an option mandatory. If a value has not been selected, it will prevent the form from submitting and display an error message.

  
    Light roast
    Medium roast
    Dark roast
  
  Submit

<form class="validation">
  <cs-radio-group label="Coffee roast" name="roast" required>
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <br />
  <cs-button appearance="filled" type="submit" variant="neutral">Submit</cs-button>
</form>

<script type="module">
  const form = document.querySelector('.validation');

  // Handle form submit
  form.addEventListener('submit', event => {
    event.preventDefault();
    alert('All fields are valid!');
  });
</script>

Custom Validity

Use the setCustomValidity() method to set a custom validation message. This will prevent the form from submitting and make the browser display the error message you provide. To clear the error, call this function with an empty string.

  
    Light roast
    Medium roast
    Dark roast
  
  Submit

<form class="custom-validity">
  <cs-radio-group label="Coffee roast" name="roast" value="light">
    <cs-radio value="light">Light roast</cs-radio>
    <cs-radio value="medium">Medium roast</cs-radio>
    <cs-radio value="dark">Dark roast</cs-radio>
  </cs-radio-group>
  <br />
  <cs-button appearance="filled" type="submit" variant="neutral">Submit</cs-button>
</form>

<script type="module">
  const form = document.querySelector('.custom-validity');
  const radioGroup = form.querySelector('cs-radio-group');
  const errorMessage = 'Sorry, we only have dark roast today';

  // Set initial validity as soon as the element is defined
  customElements.whenDefined('cs-radio-group').then(() => {
    radioGroup.setCustomValidity(errorMessage);
  });

  // Update validity when a selection is made
  form.addEventListener('change', () => {
    const isValid = radioGroup.value === 'dark';
    radioGroup.setCustomValidity(isValid ? '' : errorMessage);
  });

  // Handle form submit
  form.addEventListener('submit', event => {
    event.preventDefault();
    alert('All fields are valid!');
  });
</script>

API

Importing

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.

npm

Self-Hosted

React

import '@cruglobal/cornerstone-components/components/radio-group/radio-group.js';

import './cornerstone/components/radio-group/radio-group.js';

import CsRadioGroup from '@cruglobal/cornerstone-components/react/radio-group/index.js';

Slots

Learn more about using slots.

Name	Description
(default)	The default slot where `<cs-radio>` elements are placed.
`hint`	Text that describes how to use the radio group. Alternatively, you can use the `hint` attribute.
`label`	The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute.

Attributes & Properties

Learn more about attributes and properties.

Property	Attribute	Description	Type	Default	Reflects
`defaultValue`	`value`	The default value of the form control. Primarily used for resetting the form control.	`string \| null`	—	Yes
`disabled`	`disabled`	Disables the radio group and all child radios.	`boolean`	`false`	Yes
`form`	—	By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside of a form and associate it with the form that has this `id`. The form must be in the same document or shadow root for this to work.	`HTMLFormElement \| null`	—	—
`hint`	`hint`	The radio groups's hint. If you need to display HTML, use the `hint` slot instead.	`string`	`''`	—
`label`	`label`	The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot instead.	`string`	`''`	—
`name`	`name`	The name of the radio group, submitted as a name/value pair with form data.	`string \| null`	`null`	Yes
`orientation`	`orientation`	The orientation in which to show radio items.	`'horizontal' \| 'vertical'`	`'vertical'`	Yes
`required`	`required`	Ensures a child radio is checked before allowing the containing form to submit.	`boolean`	`false`	Yes
`size`	`size`	The radio group's size. When present, this size will be applied to all `<cs-radio>` items inside.	`'xs' \| 's' \| 'm' \| 'l' \| 'xl'`	—	Yes
`ssrHint`	`ssr-hint`	Only required for SSR. Set to `true` if you're slotting in a `hint` element so the server-rendered markup includes the hint before the component hydrates on the client.	`boolean`	`false`	—
`ssrLabel`	`ssr-label`	Only required for SSR. Set to `true` if you're slotting in a `label` element so the server-rendered markup includes the label before the component hydrates on the client.	`boolean`	`false`	—
`validationTarget`	—	We use the first available radio as the validationTarget similar to native HTML that shows the validation popup on the first radio element.	`undefined \| HTMLElement`	—	—
`validators`	—	Validators are static because they have `observedAttributes`, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator.	`Validator[]`	`[]`	—
`value`	—	The current value of the radio group, submitted as a name/value pair with form data.	—	—	—

Methods

Learn more about methods.

Name	Description	Arguments
`focus()`	Sets focus on the radio group.	`options: FocusOptions`
`formStateRestoreCallback()`	Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue.	`state: string \| File \| FormData \| null, reason: 'autocomplete' \| 'restore'`
`resetValidity()`	Reset validity is a way of removing manual custom errors and native validation.	—
`setCustomValidity()`	Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators.	`message: string`

Events

Learn more about events.

Name	Description
`change`	Emitted when the radio group's selected value changes.
`cs-invalid`	Emitted when the form control has been checked for validity and its constraints aren't satisfied.
`input`	Emitted when the radio group receives user input.

CSS Parts

Learn more about CSS parts.

Name	Description	CSS selector
`form-control`	The form control that wraps the label, input, and hint.	`::part(form-control)`
`form-control-input`	The element that wraps the grouped radios, styled as a flex container by default.	`::part(form-control-input)`
`form-control-label`	The label.	`::part(form-control-label)`
`hint`	The hint's wrapper.	`::part(hint)`

Dependencies

This component automatically imports the following elements. Sub-dependencies, if any exist, are included in this list.

Quick Links

Recent Searches