Beta Preview

RadioGroup

Radio groups 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.

Favorite pet
 
size 
orientation 
labelPosition 
 
contextualHelp 
isEmphasized 
isDisabled 
import {RadioGroup, Radio} from '@react-spectrum/s2';

<RadioGroup label="Favorite pet">
  <Radio value="cats">Cat</Radio>
  <Radio value="dogs">Dog</Radio>
  <Radio value="dragon">Dragon</Radio>
</RadioGroup>

Value

Use the value or defaultValue prop to set the selected item, and onChange to handle selection changes.

Favorite sport

Current selection: None

import {RadioGroup, Radio} from '@react-spectrum/s2';
import {useState} from 'react';

function Example() {
  let [selected, setSelected] = useState(null);

  return (
    <>
      <RadioGroup
        label="Favorite sport"
        value={selected}
        onChange={setSelected}>
        <Radio value="soccer">Soccer</Radio>
        <Radio value="baseball">Baseball</Radio>
        <Radio value="basketball">Basketball</Radio>
      </RadioGroup>
      <p>Current selection: {selected || 'None'}</p>
    </>
  );
}

Forms

Use the name prop to submit the selected radio to the server. Set the isRequired prop to validate that the user selects an option, or implement custom client or server-side validation. See the Forms guide to learn more.

Favorite pet 
isRequired 
necessityIndicator 
import {RadioGroup, Radio, Button, Form} from '@react-spectrum/s2';

function Example(props) {
  return (
    <Form>
      <RadioGroup
        {...props}
        label="Favorite pet"
        name="pet"
        isRequired
      >
        <Radio value="dog">Dog</Radio>
        <Radio value="cat">Cat</Radio>
        <Radio value="dragon">Dragon</Radio>
      </RadioGroup>
      <Button type="submit">Submit</Button>
    </Form>
  );
}

API

<RadioGroup>
  <Radio />
</RadioGroup>

RadioGroup

NameTypeDefault
childrenReactNodeDefault:
The Radios contained within the RadioGroup.
size'S''M''L''XL'Default: 'M'
The size of the RadioGroup.
orientationDefault: 'vertical'
The axis the radio elements should align with.
isEmphasizedbooleanDefault:
Whether the RadioGroup should be displayed with an emphasized style.
isDisabledbooleanDefault:
Whether the input is disabled.
isReadOnlybooleanDefault:
Whether the input can be selected but not changed by the user.
stylesDefault:
Spectrum-defined styles, returned by the style() macro.
valuestringnullDefault:
The current value (controlled).
defaultValuestringnullDefault:
The default value (uncontrolled).
onChange(value: string) => voidDefault:
Handler that is called when the value changes.

Radio

NameType
childrenReactNode
The label for the element.
inputRef<HTMLInputElementnull>
A ref for the HTML input element.
isDisabledboolean
Whether the radio button is disabled or not. Shows that a selection exists, but is not available in that circumstance.
styles
Spectrum-defined styles, returned by the style() macro.