Form.Radio

Edit this page Leave feedback

A simple radio button for use with Form.RadioSet.

Note: extra props added to this component are passed as attributes to the underlying input node. See MDN for documentation on available input attributes.

Controlled Usage

Show editable code example

Any Paragon component or export may be added to the code example.

() => {
  const [value, setValue] = useState('green');
  const handleChange = e => setValue(e.target.value);
  return (
    <Form.Group>
      <Form.Label>Which Color?</Form.Label>
      <Form.RadioSet
        name="colors"
        onChange={handleChange}
        value={value}
      >
        <Form.Radio value="red">Red</Form.Radio>
        <Form.Radio value="green">Green</Form.Radio>
        <Form.Radio value="blue">Blue</Form.Radio>
        <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
      </Form.RadioSet>
    </Form.Group>
  );
}

() => {
  const [value, setValue] = useState('green');
  const handleChange = e => setValue(e.target.value);
  return (
    <Form.Group>
      <Form.Label>Which Color?</Form.Label>
      <Form.RadioSet
        name="colors"
        onChange={handleChange}
        value={value}
      >
        <Form.Radio value="red">Red</Form.Radio>
        <Form.Radio value="green">Green</Form.Radio>
        <Form.Radio value="blue">Blue</Form.Radio>
        <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
      </Form.RadioSet>
    </Form.Group>
  );
}

Unlabeled Control

Show editable code example

Any Paragon component or export may be added to the code example.

() => {
  const [value, setValue] = useState('green');
  const handleChange = e => setValue(e.target.value);

  return (
    <Form.RadioSet name="colors-unlabeled" onChange={handleChange} value={value}>
      <RadioControl value="red" />
      <RadioControl value="green" />
    </Form.RadioSet>
  )
}

() => {
  const [value, setValue] = useState('green');
  const handleChange = e => setValue(e.target.value);

  return (
    <Form.RadioSet name="colors-unlabeled" onChange={handleChange} value={value}>
      <RadioControl value="red" />
      <RadioControl value="green" />
    </Form.RadioSet>
  )
}

Uncontrolled Usage

Show editable code example

Any Paragon component or export may be added to the code example.

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-two"
    onChange={(e) => console.log(e.target.value)}
    defaultValue="green"
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
</Form.Group>

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-two"
    onChange={(e) => console.log(e.target.value)}
    defaultValue="green"
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
</Form.Group>

Inline layout

Show editable code example

Any Paragon component or export may be added to the code example.

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-three"
    onChange={(e) => console.log(e.target.value)}
    defaultValue="green"
    isInline
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
</Form.Group>

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-three"
    onChange={(e) => console.log(e.target.value)}
    defaultValue="green"
    isInline
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
</Form.Group>

Validation

Group Level Validation

Show editable code example

Any Paragon component or export may be added to the code example.

<Form.Group isInvalid>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-five"
    onChange={(e) => console.log(e.target.value)}
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
  <Form.Control.Feedback>
    Please choose an option.
  </Form.Control.Feedback>
</Form.Group>

<Form.Group isInvalid>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet
    name="color-five"
    onChange={(e) => console.log(e.target.value)}
  >
    <Form.Radio value="red">Red</Form.Radio>
    <Form.Radio value="green">Green</Form.Radio>
    <Form.Radio value="blue">Blue</Form.Radio>
    <Form.Radio value="cyan" disabled>Cyan</Form.Radio>
  </Form.RadioSet>
  <Form.Control.Feedback>
    Please choose an option.
  </Form.Control.Feedback>
</Form.Group>

Individual option validation

Show editable code example

Any Paragon component or export may be added to the code example.

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet name="color-four">
    <Form.Radio
      value="red"
      description="Red's cool"
    >
      Red
    </Form.Radio>
    <Form.Radio
      value="green"
      description="Excellent choice"
      isValid
    >
      Green
    </Form.Radio>
    <Form.Radio
      value="blue"
      description="Poor choice"
      isInvalid
    >
      Blue
    </Form.Radio>
    <Form.Radio
      value="cyan"
      disabled
    >
      Cyan
    </Form.Radio>
  </Form.RadioSet>
</Form.Group>

<Form.Group>
  <Form.Label>Which Color?</Form.Label>
  <Form.RadioSet name="color-four">
    <Form.Radio
      value="red"
      description="Red's cool"
    >
      Red
    </Form.Radio>
    <Form.Radio
      value="green"
      description="Excellent choice"
      isValid
    >
      Green
    </Form.Radio>
    <Form.Radio
      value="blue"
      description="Poor choice"
      isInvalid
    >
      Blue
    </Form.Radio>
    <Form.Radio
      value="cyan"
      disabled
    >
      Cyan
    </Form.Radio>
  </Form.RadioSet>
</Form.Group>

Radio standalone usage

This is supported, but not recommended.

Show editable code example

Any Paragon component or export may be added to the code example.

<>
  <Form.Radio className="ml-2" name="color" value="red">Red</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="green" defaultChecked>Green</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="blue">Blue</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="cyan" disabled>Cyan</Form.Radio>
</>

<>
  <Form.Radio className="ml-2" name="color" value="red">Red</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="green" defaultChecked>Green</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="blue">Blue</Form.Radio>
  <Form.Radio className="ml-2" name="color" value="cyan" disabled>Cyan</Form.Radio>
</>

Theme Variables#

CSS Variable	Computed Value
‌	‌
‌	‌
‌	‌
‌	‌
‌	‌

Props API#

FormRadio Props API

id string
Specifies id of the FormRadio component.
children node Required
Specifies contents of the component.
className string
Specifies class name to append to the base element.
controlClassName string
Specifies class name for control component.
labelClassName string
Specifies class name for label component.
description node
Specifies description to show under the radio's value.
isInvalid bool
Specifies whether to display component in invalid state, this affects styling.
Defaultfalse
isValid bool
Specifies whether to display component in valid state, this affects styling.
Defaultfalse
disabled bool
Specifies whether the FormRadio is disabled.
Defaultfalse

FormRadioSet Props API

children node Required
Specifies contents of the component.
className string
A class name to append to the base element.
name string Required
Specifies name for the component.
value string
Specifies values for the FormRadioSet.
defaultValue string
Specifies default values.
isInline bool
Specifies whether the component should be displayed with inline styling.
Defaultfalse
onChange func
Specifies onChange event handler.
onFocus func
Specifies onFocus event handler.
onBlur func
Specifies onBlur event handler.

Usage Insights#

FormRadio

	Project Name	Paragon Version	Instance Count
	frontend-app-account	20.46.3	2
	frontend-app-admin-portal	20.46.3	6
	frontend-app-course-authoring	21.5.6	11
	frontend-app-discussions	20.46.3	3
	frontend-app-learner-dashboard	20.46.2	6
	frontend-app-ora-grading	20.46.3	1
	frontend-app-support-tools	20.46.0	5
	frontend-lib-content-components	21.5.6	5
	www	20.36.0	3
	prospectus	20.46.2	4

FormRadioSet

	Project Name	Paragon Version	Instance Count
	frontend-app-account	20.46.3	1
	frontend-app-admin-portal	20.46.3	4
	frontend-app-course-authoring	21.5.6	6
	frontend-app-discussions	20.46.3	8
	frontend-app-learner-dashboard	20.46.2	3
	frontend-app-ora-grading	20.46.3	1
	frontend-app-support-tools	20.46.0	5
	frontend-lib-content-components	21.5.6	3
	www	20.36.0	2
	prospectus	20.46.2	2

Edit this page Leave feedback

Contents

Controlled Usage
Unlabeled Control
Uncontrolled Usage
Inline layout
Validation
- Group Level Validation
- Individual option validation
Radio standalone usage
Theme Variables
Props API
Usage Insights