Radio buttons are UI elements that allow the selection of a single option from a set of mutually exclusive choices.

Components design versions:

  • Radio button item v1.4.0
  • Radio button v1.4.0

Note

Design guidelines

For usage guidance, please refer to the radio button design guidelines and the radio button item design guidelines.

Overview

Component types

  • Radio button item is a UI element shaped like a row that allows users to select a single option from a set of mutually exclusive choices.
  • Radio button is a UI element that allows users to select a single option from a set of mutually exclusive choices.

Radio button item

Radio button item is a UI element shaped like a row that allows users to select a single option from a set of mutually exclusive choices.

Unlike the standalone radio button, the radio button item accommodates a broader range of contexts by enabling the toggling of visibility of additional text labels and icon assets.

They are implemented using .radio-button-item and .control-item-* classes, see below. Browser default radio buttons are replaced with the help of the selector .control-item-indicator[type="radio"].

<fieldset class="control-items-list">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemDefault" name="radioBasic" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemDefault">Default radio button item</label>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input checked class="control-item-indicator" type="radio" value="" id="radioButtonItemDefault2" name="radioBasic" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemDefault2">Checked radio button item</label>
    </div>
  </div>

</fieldset>
html
Bootstrap $enable-bootstrap-compatibility: true

Note

This part is enabled only when $enable-bootstrap-compatibility is set to true.

Read more about Bootstrap compatibility
<div class="form-check">
  <input class="form-check-input" type="radio" value="" id="radioButtonItemCheckDefault" name="radioBasicBs" />
  <label class="form-check-label" for="radioButtonItemCheckDefault">
    Default radio button item (Bootstrap compatible)
  </label>
</div>

<div class="form-check">
  <input checked class="form-check-input" type="radio" value="" id="radioButtonItemCheckChecked" name="radioBasicBs" />
  <label class="form-check-label" for="radioButtonItemCheckChecked">
    Checked radio button item (Bootstrap compatible)
  </label>
</div>
html

Approach

Control item

Control item is an abstraction for several non-text input components, like checkbox item, radio button item and switch item, that have similar behavior and layout. It contains an <input /> indicator, a text container for the label and an optional icon.

We use the parent element selector (:has) for all our <input /> states, like :invalid or :disabled. When combined with the .control-item-label class, we can easily style the text for each item based on the <input />’s state.

.control-item-assets-container controls the position of the .control-item-indicator and the optional icon.

.control-item-text-container contains the label and optional description and controls their positioning.

.control-item-label extend their clickable area until a .checkbox-standalone, .radio-button-standalone, .switch-standalone or a position: relative; is found in the page hierarchy. This ensures a consistent approach, whatever the DOM is. Consequently, none of the elements next to the label should be interactive.

.control-item-indicator uses customized icons to indicate checked states.

Control items list

As radio button items are almost always grouped in a list, they should be enclosed in a <fieldset> element with a .control-items-list class, this will handle automatic error text display when one of the control items input is invalid; you can add a <legend> element as a title for the list read more.

Accessibility

Max-width for accessibility

To maintain a clear visual hierarchy and ensure Assistive Technology users do not have to scroll back and forth across large areas of whitespace to understand what an action does, keep actions and meaningful icons physically adjacent to their descriptive labels. Make use of our component max-width utility to control the width of your components if needed.

Variants

Divider

To display a divider, add .control-item-divider to a .radio-button-item.

<fieldset class="control-items-list">

  <div class="radio-button-item control-item-divider">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemDivider" name="radioDivider" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemDivider">Default radio button item with divider</label>
    </div>
  </div>

  <div class="radio-button-item control-item-divider">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemDivider2" name="radioDivider" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemDivider2">Checked radio button item with divider</label>
    </div>
  </div>

</fieldset>
html

Icon

Note

The recommended way to use icons is to fill an SVG sprite file, and use currentColor for styling. If really necessary, for example when you have a lot of icons, you can use an icon font. Find out more about using icons.

To display an icon, add .control-item-assets-container with an icon (SVG or font-icon most likely) inside, as a child of a .radio-button-item.

<fieldset class="control-items-list">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithSVG" name="radioIcon" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithSVG">Default radio button item with an SVG icon</label>
    </div>
    <div class="control-item-assets-container">
      <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
        <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
      </svg>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithIconFont" name="radioIcon" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithIconFont">Checked radio button item with a font-icon</label>
    </div>
    <div class="control-item-assets-container">
      <span class="icon si si-settings" aria-hidden="true"></span>
    </div>
  </div>

</fieldset>
html

Extra label

To add critical information to some of the options, add a .radio-button-extra-label as a sibling of a .control-item-label. Make sure the extra label is accessible by adding an aria-describedby attribute to the input.

Extra label

Extra label

<fieldset class="control-items-list">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithExtraLabel" aria-describedby="radioButtonItemExtraLabel" name="radioExtraLabel" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithExtraLabel">Default radio button item</label>
      <p class="radio-button-extra-label" id="radioButtonItemExtraLabel">Extra label</p>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithExtraLabel2" aria-describedby="radioButtonItemExtraLabel2" name="radioExtraLabel" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithExtraLabel2">Checked radio button item</label>
      <p class="radio-button-extra-label" id="radioButtonItemExtraLabel2">Extra label</p>
    </div>
  </div>

</fieldset>
html

Description text

To display a description text, add a .control-item-description as a sibling of a .control-item-label. Make sure the description is accessible by adding an aria-describedby attribute to the input.

Extra label and description text can be combined, but the extra label must come first (visually and in the aria-describedby attribute).

Description text

Extra label

Description text

<fieldset class="control-items-list">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithDescription" aria-describedby="radioButtonItemDescription" name="radioTextDescription" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithDescription">Default radio button item</label>
      <p class="control-item-description" id="radioButtonItemDescription">Description text</p>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemWithDescription2" aria-describedby="radioButtonItemDescriptionExtraLabel radioButtonItemDescription2" name="radioTextDescription" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithDescription2">Checked radio button item</label>
      <p class="radio-button-extra-label" id="radioButtonItemDescriptionExtraLabel">Extra label</p>
      <p class="control-item-description" id="radioButtonItemDescription2">Description text</p>
    </div>
  </div>

</fieldset>
html

Outlined

To display outlined radio button items, add .radio-button-item-outlined to a .radio-button-item. If there is an outlined radio button item in a group, all its siblings should also be outlined.

<fieldset class="control-items-list">

  <div class="radio-button-item radio-button-item-outlined">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemOutlined1" name="radioOutlined" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemOutlined1">Default outlined radio button item</label>
    </div>
  </div>

  <div class="radio-button-item radio-button-item-outlined">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemOutlined2" name="radioOutlined" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemOutlined2">Checked outlined radio button item</label>
    </div>
  </div>

</fieldset>
html

States

Disabled

Add the disabled attribute to the input, then the radio button item and the associated <label> are automatically styled to match with a lighter color to help indicate the input’s state.

Extra label

Description text

<fieldset class="control-items-list">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input disabled class="control-item-indicator" type="radio" value="" id="radioButtonItemDisabled" name="radioDisabled" aria-describedby="radioButtonItemDisabledExtraLabel radioButtonItemDisabledDescription"/>
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemDisabled">Default disabled radio button item</label>
      <p class="radio-button-extra-label" id="radioButtonItemDisabledExtraLabel">Extra label</p>
      <p class="control-item-description" id="radioButtonItemDisabledDescription">Description text</p>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input disabled class="control-item-indicator" type="radio" value="" id="radioButtonItemCheckedDisabled" name="radioDisabled" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemCheckedDisabled">Checked disabled radio button item</label>
    </div>
  </div>

</fieldset>
html
Bootstrap $enable-bootstrap-compatibility: true

Note

This part is enabled only when $enable-bootstrap-compatibility is set to true.

Read more about Bootstrap compatibility
<div class="form-check">
  <input disabled class="form-check-input" type="radio" value="" id="radioButtonItemCheckDisabled" name="radioDisabledBs" />
  <label class="form-check-label" for="radioButtonItemCheckDisabled">
    Default disabled radio button item
  </label>
</div>

<div class="form-check">
  <input disabled class="form-check-input" type="radio" value="" id="radioButtonItemCheckCheckedDisabled" name="radioDisabledBs" checked />
  <label class="form-check-label" for="radioButtonItemCheckCheckedDisabled">
    Checked disabled radio button item
  </label>
</div>
html

Read only

To create a read only radio button item, the input should be replaced by a span element with role="radio" and aria-disabled="true" attributes. All the radio button items in the group must be surrounded by a container with role="radiogroup" and aria-readonly="true" attributes. This is the only way to be compliant with ARIA specifications. The radio button item will be accessible to keyboard navigation and assistive technologies, thanks to aria-labelledby and tabindex, but other interactions will be prevented.

Default readonly radio button item

Extra label

Description text

Checked readonly radio button item

<fieldset class="control-items-list">
  <div role="radiogroup" aria-readonly="true">

    <div class="radio-button-item">
      <div class="control-item-assets-container">
        <span class="control-item-indicator" role="radio" aria-disabled="true" tabindex="0" aria-checked="false" aria-labelledby="radioButtonItemReadonlyLabel" aria-describedby="radioButtonItemReadonlyExtraLabel radioButtonItemReadonlyDescription"></span>
      </div>
      <div class="control-item-text-container">
        <p class="control-item-label" id="radioButtonItemReadonlyLabel">Default readonly radio button item</p>
        <p class="radio-button-extra-label" id="radioButtonItemReadonlyExtraLabel">Extra label</p>
        <p class="control-item-description" id="radioButtonItemReadonlyDescription">Description text</p>
      </div>
    </div>

    <div class="radio-button-item">
      <div class="control-item-assets-container">
        <span class="control-item-indicator" role="radio" aria-disabled="true" tabindex="0" aria-checked="true" aria-labelledby="radioButtonItemReadonlyCheckedLabel"></span>
      </div>
      <div class="control-item-text-container">
        <p class="control-item-label" id="radioButtonItemReadonlyCheckedLabel">Checked readonly radio button item</p>
      </div>
    </div>

  </div>
</fieldset>
html

Invalid

Note

The invalid state is the equivalent of the ‘Error’ state that you can find in the design specification.

Note

Prefer built-in form validation to handle client-side validation

When using semantic inputs and validation constraints attributes (like required, pattern...), the browser automatically adds a :user-invalid pseudo-class on invalid fields that OUDS Web will style.

Alternatively you can programmatically add a aria-invalid="true" to manually mark a field as invalid.

Read more in our form validation page for mandatory accessibility considerations.

To manually mark a radio button item as invalid, add the aria-invalid="true" attribute to a .control-item-indicator. An error icon will be automatically shown; if a decorative icon is specified, it will be hidden.

Extra label

Description text

Description text

There is an error.

<fieldset class="control-items-list">

  <div class="radio-button-item control-item-divider">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" aria-invalid="true" type="radio" value="" name="radioInvalid" id="radioButtonItemInvalid" aria-describedby="radioButtonItemInvalidExtraLabel radioButtonItemInvalidDescription radioButtonItemInvalidErrorText" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemInvalid">Default invalid radio button item</label>
      <p class="radio-button-extra-label" id="radioButtonItemInvalidExtraLabel">Extra label</p>
      <p class="control-item-description" id="radioButtonItemInvalidDescription">Description text</p>
    </div>
  </div>

  <div class="radio-button-item control-item-divider">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" aria-invalid="true" type="radio" value="" name="radioInvalid" id="radioButtonItemInvalid2" aria-describedby="radioButtonItemInvalid2Description radioButtonItemInvalidErrorText" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemInvalid2">Checked invalid radio button item</label>
      <p class="control-item-description" id="radioButtonItemInvalid2Description">Description text</p>
    </div>
  </div>

  <p class="control-item-error-message" id="radioButtonItemInvalidErrorText">There is an error.</p>

</fieldset>
html
Bootstrap $enable-bootstrap-compatibility: true

Note

This part is enabled only when $enable-bootstrap-compatibility is set to true.

Read more about Bootstrap compatibility

To display an invalid radio button item, add .is-invalid to a .form-check-input.

<div class="form-check">
  <input class="form-check-input is-invalid" type="radio" value="" id="radioButtonItemInvalidBootstrap" />
  <label class="form-check-label" for="radioButtonItemInvalidBootstrap">
    Invalid radio button item
  </label>
</div>
html
Outlined

This also works for outlined variant of the component.

Forbidden choice.

<fieldset class="control-items-list">

  <div class="radio-button-item radio-button-item-outlined">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" aria-invalid="true" type="radio" value="" name="outlinedInvalid" id="radioButtonItemOutlinedInvalid1" aria-describedby="radioButtonItemOutlinedInvalidErrorText" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemOutlinedInvalid1">Default invalid outlined radio button item</label>
    </div>
  </div>

  <div class="radio-button-item radio-button-item-outlined">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" aria-invalid="true" type="radio" value="" name="outlinedInvalid" id="radioButtonItemOutlinedInvalid2" checked aria-describedby="radioButtonItemOutlinedInvalidErrorText" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemOutlinedInvalid2">Checked invalid outlined radio button item</label>
    </div>
  </div>

  <p class="control-item-error-message" id="radioButtonItemOutlinedInvalidErrorText">Forbidden choice.</p>

</fieldset>
html
Horizontal

If the layout is horizontal, the <fieldset> must enclose the flex containers so the error message is displayed under the first item.

Please make a choice.

<fieldset class="control-items-list">
  <div class="d-flex flex-row gap-small w-50">

    <div class="radio-button-item flex-fill">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" aria-invalid="true" type="radio" value="" id="radioButtonItemLayoutRowInvalid1" name="radioLayoutRowInvalid" aria-describedby="radioButtonItemLayoutRowInvalidErrorText" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemLayoutRowInvalid1">Option 1</label>
      </div>
    </div>

    <div class="radio-button-item flex-fill">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" aria-invalid="true" type="radio" value="" id="radioButtonItemLayoutRowInvalid2" name="radioLayoutRowInvalid" aria-describedby="radioButtonItemLayoutRowInvalidErrorText" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemLayoutRowInvalid2">Option 2</label>
      </div>
    </div>

  </div>

  <p class="control-item-error-message" id="radioButtonItemLayoutRowInvalidErrorText">Please make a choice.</p>

</fieldset>
html

Skeleton

To set the radio button item in skeleton state, it needs to be wrapped in an [aria-busy="true"] container that also has the inert attribute. To get more information, please refer to the skeleton documentation.

<div aria-busy="true" inert>
  <fieldset class="control-items-list">

    <div class="radio-button-item">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" type="radio" value="" id="radioButtonItemSkeleton" name="radioSkeleton" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemSkeleton">Default radio button item</label>
      </div>
    </div>

    <div class="radio-button-item">
      <div class="control-item-assets-container">
        <input checked class="control-item-indicator" type="radio" value="" id="radioButtonItemSkeleton2" name="radioSkeleton" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemSkeleton2">Checked radio button item</label>
      </div>
    </div>

  </fieldset>
</div>
html

Layout

Default

It's recommended to keep radio button item labels to no more than three words. When space is limited or when a long label, extra label or description text is required, the text can wrap, as this is preferable to truncation. The radio button indicator and the icon will remain vertically centered, until the .control-item-assets-container reaches a defined maximum height.

Extra label

Description text

Radio button indicator and icon will stick to the top area of the component

Also a longer description text, it will also wrap at some point depending on the component width

<div class="row">
  <div class="col-8 md:col-6 xl:col-5">
    <fieldset class="control-items-list">

      <div class="radio-button-item control-item-divider">
        <div class="control-item-assets-container">
          <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayout1" name="radioLayout" aria-describedby="radioButtonItemLayout1ExtraLabel radioButtonItemLayout1Description" />
        </div>
        <div class="control-item-text-container">
          <label class="control-item-label" for="radioButtonItemLayout1">Label</label>
          <p class="radio-button-extra-label" id="radioButtonItemLayout1ExtraLabel">Extra label</p>
          <p class="control-item-description" id="radioButtonItemLayout1Description">Description text</p>
        </div>
        <div class="control-item-assets-container">
          <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
            <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
          </svg>
        </div>
      </div>

      <div class="radio-button-item control-item-divider">
        <div class="control-item-assets-container">
          <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayout2" name="radioLayout"  aria-describedby="radioButtonItemLayout2ExtraLabel radioButtonItemLayout2Description" checked />
        </div>
        <div class="control-item-text-container">
          <label class="control-item-label" for="radioButtonItemLayout2">A longer label for showing behavior in this case</label>
          <p class="radio-button-extra-label" id="radioButtonItemLayout2ExtraLabel">Radio button indicator and icon will stick to the top area of the component</p>
          <p class="control-item-description" id="radioButtonItemLayout2Description">Also a longer description text, it will also wrap at some point depending on the component width</p>
        </div>
        <div class="control-item-assets-container">
          <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
            <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
          </svg>
        </div>
      </div>

    </fieldset>
  </div>
</div>
html

Reverse

To reverse the radio button item, simply add .control-item-reverse to a .radio-button-item.

Extra label

Description text

Radio button indicator and icon will stick to the top area of the component

Also a longer description text, it will also wrap at some point depending on the component width

<div class="row">
  <div class="col-8 md:col-6 xl:col-5">
    <fieldset class="control-items-list">

      <div class="radio-button-item control-item-divider control-item-reverse">
        <div class="control-item-assets-container">
          <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayoutRev1" name="radioLayoutRev" aria-describedby="radioButtonItemLayoutRev1ExtraLabel radioButtonItemLayoutRev1Description" />
        </div>
        <div class="control-item-text-container">
          <label class="control-item-label" for="radioButtonItemLayoutRev1">Label with reverse layout</label>
          <p class="radio-button-extra-label" id="radioButtonItemLayoutRev1ExtraLabel">Extra label</p>
          <p class="control-item-description" id="radioButtonItemLayoutRev1Description">Description text</p>
        </div>
        <div class="control-item-assets-container">
          <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
            <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
          </svg>
        </div>
      </div>

      <div class="radio-button-item control-item-divider control-item-reverse">
        <div class="control-item-assets-container">
          <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayoutRev2" name="radioLayoutRev"  aria-describedby="radioButtonItemLayoutRev2ExtraLabel radioButtonItemLayoutRev2Description" checked />
        </div>
        <div class="control-item-text-container">
          <label class="control-item-label" for="radioButtonItemLayoutRev2">A longer label with reverse layout for showing behavior in this case</label>
          <p class="radio-button-extra-label" id="radioButtonItemLayoutRev2ExtraLabel">Radio button indicator and icon will stick to the top area of the component</p>
          <p class="control-item-description" id="radioButtonItemLayoutRev2Description">Also a longer description text, it will also wrap at some point depending on the component width</p>
        </div>
        <div class="control-item-assets-container">
          <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
            <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
          </svg>
        </div>
      </div>

    </fieldset>
  </div>
</div>
html
Bootstrap $enable-bootstrap-compatibility: true

Note

This part is enabled only when $enable-bootstrap-compatibility is set to true.

Read more about Bootstrap compatibility

Put your radio button items on the opposite side with the .form-check-reverse modifier class.

<div class="form-check form-check-reverse">
  <input class="form-check-input" type="radio" value="" id="radioButtonItemReverseCheck1" name="radioReverseBs" />
  <label class="form-check-label" for="radioButtonItemReverseCheck1">
    Default reverse radio button item (Bootstrap compatible)
  </label>
</div>

<div class="form-check form-check-reverse">
  <input class="form-check-input" type="radio" value="" id="radioButtonItemReverseCheck2" name="radioReverseBs" checked />
  <label class="form-check-label" for="radioButtonItemReverseCheck2">
    Checked reverse radio button item (Bootstrap compatible)
  </label>
</div>
html

Horizontal

You can align horizontally up to three radio button items if their labels are short, add sufficient space (for example by using .gap-small) between the controls to ensure a clear association of each label with its corresponding indicator.

<fieldset class="control-items-list">
  <div class="d-flex flex-row gap-small w-50">

    <div class="radio-button-item flex-fill">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayoutRow1" name="radioLayoutRow" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemLayoutRow1">Option 1</label>
      </div>
    </div>

    <div class="radio-button-item flex-fill">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" type="radio" value="" id="radioButtonItemLayoutRow2" name="radioLayoutRow" checked />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemLayoutRow2">Option 2</label>
      </div>
    </div>

  </div>
</fieldset>
html

Max width

By default, radio button items will span the whole width of their parent container. To limit their width on a wider parent container, add a .component-max-width to the .radio-button-item container. More information on radio button item sizing in the design guidelines.

Description text

Description text

<fieldset class="control-items-list">

  <div class="radio-button-item component-max-width">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" aria-describedby="radioButtonItemMWDescription" id="radioButtonItemWithMaxWidth" value="" name="radioMaxWidth" />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithMaxWidth">Default radio button item</label>
      <p class="control-item-description" id="radioButtonItemMWDescription">Description text</p>
    </div>
  </div>

  <div class="radio-button-item component-max-width">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" aria-describedby="radioButtonItemWithMaxWidth2Description" id="radioButtonItemWithMaxWidth2" value="" name="radioMaxWidth" checked />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="radioButtonItemWithMaxWidth2">Checked radio button item</label>
      <p class="control-item-description" id="radioButtonItemWithMaxWidth2Description">Description text</p>
    </div>
  </div>

</fieldset>
html

Fieldset <legend>

For accessibility reasons, it is required to provide understandable radio button item labels without relying on visual context. It is also good practice to add a radio button item group title inside a <legend> element as the first child of the <fieldset> element. Screen readers will read the legend before navigating through the radio button items; this way, keyboard navigation users have more information on what is expected with the multiple radio button items element.

Radio button items group example

Extra label

Description text

Extra label

Description text

<div class="row">
  <fieldset class="md:col-6">
    <legend>Radio button items group example</legend>

    <div class="radio-button-item control-item-divider">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" type="radio" value="" id="radioButtonItemGroup1" name="radioGroup" aria-describedby="radioButtonItemGroup1ExtraLabel radioButtonItemGroup1Description" />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemGroup1">Radio button item 1</label>
        <p class="radio-button-extra-label" id="radioButtonItemGroup1ExtraLabel">Extra label</p>
        <p class="control-item-description" id="radioButtonItemGroup1Description">Description text</p>
      </div>
      <div class="control-item-assets-container">
        <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
          <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
        </svg>
      </div>
    </div>

    <div class="radio-button-item control-item-divider">
      <div class="control-item-assets-container">
        <input class="control-item-indicator" type="radio" value="" id="radioButtonItemGroup2" name="radioGroup"  aria-describedby="radioButtonItemGroup2ExtraLabel radioButtonItemGroup2Description" checked />
      </div>
      <div class="control-item-text-container">
        <label class="control-item-label" for="radioButtonItemGroup2">Radio button item 2</label>
        <p class="radio-button-extra-label" id="radioButtonItemGroup2ExtraLabel">Extra label</p>
        <p class="control-item-description" id="radioButtonItemGroup2Description">Description text</p>
      </div>
      <div class="control-item-assets-container">
        <svg width="1rem" height="1rem" fill="currentColor" aria-hidden="true">
          <use xlink:href="/orange-compact/docs/1.6/assets/img/ouds-web-sprite.svg#heart-empty" />
        </svg>
      </div>
    </div>

  </fieldset>
</div>
html

Mandatory field indication

To indicate that a radio button item is mandatory in a form, add the class .is-required to display a red asterisk at the end of the label.

For general rules about when to add mandatory fields indication, please refer to the radio button item design guidelines and to the form validation documentation. In particular, do not forget to handle error messages.


Mandatory radio button items
<div class="radio-button-item-container">

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="radioButtonItemUniqueMandatory" name="mandatoryRadioButtonItem" required />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label is-required" for="radioButtonItemUniqueMandatory">Mandatory unique radio button item</label>
    </div>
  </div>
</div>

<hr class="my-xlarge">

<fieldset class="control-items-list">
  <legend class="is-required">Mandatory radio button items</legend>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input class="control-item-indicator" type="radio" value="" id="mandatoryRadioButtonItem1" name="mandatoryRadioButtonItems" required />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="mandatoryRadioButtonItem1">Default radio button item</label>
    </div>
  </div>

  <div class="radio-button-item">
    <div class="control-item-assets-container">
      <input checked class="control-item-indicator" type="radio" value="" id="mandatoryRadioButtonItem2" name="mandatoryRadioButtonItems" required />
    </div>
    <div class="control-item-text-container">
      <label class="control-item-label" for="mandatoryRadioButtonItem2">Checked radio button item</label>
    </div>
  </div>

</fieldset>
html

Radio button

Radio button is a UI element that allows users to select a single option from a set of mutually exclusive choices.

Radio button, that lacks an additional icon asset or text label, provides greater flexibility when designing other components that incorporate a radio button.

Heads up!

This standalone version is commonly used for building custom components and should not be used on its own. Remember to provide some sort of accessible name for assistive technologies (for instance, using aria-labelledby, a .visually-hidden, aria-label or a second label). See the forms validation accessibility section for details.

For the standalone radio button, we provide a completely different architecture than radio button item to ease the integration inside your projects.

<label class="radio-button-standalone">
  <input class="control-item-indicator" type="radio" value="" />
  <span class="visually-hidden">Default radio button</span>
</label>
html
Bootstrap $enable-bootstrap-compatibility: true

Note

This part is enabled only when $enable-bootstrap-compatibility is set to true.

Read more about Bootstrap compatibility

Heads up!

Be careful when using this, as you must implement the background on hover, focus and active states.

<div>
  <input class="form-check-input" type="radio" value="" aria-label="Default standalone radio button (Bootstrap compatible)" />
</div>
html

States

Disabled

Add the disabled attribute to prevent interaction with the radio button and remove it from the keyboard tab order.

<label class="radio-button-standalone">
  <input disabled class="control-item-indicator" type="radio" name="standaloneRadioDisabled" value="" />
  <span class="visually-hidden">Disabled radio button</span>
</label>
html

Read only

Radio inputs do not support the readonly attribute. Replace the inputs with elements that have role="radio" and aria-disabled="true", and put them in a container with role="radiogroup" and aria-readonly="true".

<div class="radio-button-standalone" role="radiogroup" aria-readonly="true" aria-label="Read only radio button group">
  <span class="control-item-indicator" role="radio" aria-disabled="true" tabindex="0" aria-checked="true" aria-label="Selected option"></span>
</div>
html

Invalid

Note

Prefer built-in form validation to handle client-side validation

When using semantic inputs and validation constraints attributes (like required, pattern...), the browser automatically adds a :user-invalid pseudo-class on invalid fields that OUDS Web will style.

Alternatively you can programmatically add a aria-invalid="true" to manually mark a field as invalid.

Read more in our form validation page for mandatory accessibility considerations.

To manually mark a radio button as invalid, add aria-invalid="true" to the .control-item-indicator and use aria-describedby to associate an error message with it.

Heads up!

Contrary to control items, OUDS Web does not automatically add an icon or any other error indicator for the standalone controls, it only changes its color. This is because this component should be included in others (such as tables) and adding an icon could break some layouts.

Because color alone must not be used to indicate invalidity, provide an additional accessible indicator. In the example below, we add descriptive text and associate it with the control using aria-describedby.

Choose an available option.

<div>
  <label class="radio-button-standalone">
    <input class="control-item-indicator" type="radio" name="standaloneRadioInvalid" value="" aria-invalid="true" aria-describedby="radioButtonStandaloneError" />
    <span class="visually-hidden">Radio button</span>
  </label>
  <p id="radioButtonStandaloneError">Choose an available option.</p>
</div>
html