Skip to content
Stable

Radio Group

Radio group is a container for radio inputs and is used where two or more radio inputs are required. A radio group can accomodate two styles of radio inputs ā€” a radio icon or radio button.

Installation

bash
npm install @nib-components/radio-group

As a form input, @nib-components/form-control must wrap this component to provide an accessible label, help text, and validation styling. Note: You will also need to install the peerDependencies @nib/icons and @nib-components/theme.

Usage

jsx
import RadioGroup from '@nib-components/radio-group';

Interactive demo

Radio icon style

jsx

Button style

jsx

With subtitles

jsx

Props

As the <RadioGroup/> is wrapped in a <FormControl/>, all FormControl props such as valid, validated, and disabled will be passed down to this component. This includes the id, name and label which will align with the for attribute on the <label>.

All props passed directly to <RadioGroup/> will be applied to the underlying <input> as attributes.

PropTypeDefaultDescription
options (required)object or arrayCan be an object or an array. See below for more detail.
boldLabelbooleanfalseWhether the labels are bold. If a subtitle is provided for an option, the default value changes to true for that option.
valuestring or numberThe selected value.
componentstring or React componentRadioThe component used to render a radio.

Options

The options prop accepts both an array and dictionary of items, and within each there are further configuration options.

Object

Simple key:value pairs where key is equal to the option value, and the value of the property is the label:

javascript
const options = {
small: 'Small',
medium: 'Medium',
large: 'Large'
};

Or a nested object when supporting subtitles:

javascript
const options = {
small: {
label: 'Small',
subtitle: 'Lorem ipsum'
},
medium: {
label: 'Medium',
subtitle: 'Dolor sit amet'
},
large: {
label: 'Large',
subtitle: 'Consectetuer elit'
}
};

In certain situations you may find the need to pass a ReactNode as the label:

javascript
const options = {
one: (
<Columns space={3} verticalAlign="center">
<Column width="content">
<SupportSystemIcon />
</Column>
<Column>
<Copy>Lorem ipsum</Copy>
</Column>
</Columns>
),
two: (
<Columns space={3} verticalAlign="center">
<Column width="content">
<ShoppingCartSystemIcon />
</Column>
<Column>
<Copy>Dolor sit amet</Copy>
</Column>
</Columns>
)
};

Array

Using an array guarantees order.

When using an array each item must be an object with a value and label property, and an optional subtitle property:

javascript
const options = [
{value: 'small', label: 'Small'},
{value: 'medium', label: 'Medium'},
{value: 'large', label: 'Large'}
];

Similarly, when using an array options can have subtitles and can use a ReactNode for the label:

javascript
const optionsWithSubtitles = [
{value: 'small', label: 'Small', subtitle: 'Lorem ipsum'},
{value: 'medium', label: 'Medium', subtitle: 'Dolor sit amet'},
{value: 'large', label: 'Large', subtitle: 'Consectetuer elit'}
];
const const optionsWithReactNodes = [
{
value: 'one',
label: (
<Columns space={3} verticalAlign="center">
<Column width="content">
<SupportSystemIcon />
</Column>
<Column>
<Copy>Lorem ipsum</Copy>
</Column>
</Columns>
)
},
{
value: 'two',
label: (
<Columns space={3} verticalAlign="center">
<Column width="content">
<ShoppingCartSystemIcon />
</Column>
<Column>
<Copy>Dolor sit amet</Copy>
</Column>
</Columns>
)
}
];

Considerations

Radio inputs are used when there are a number of options available and the user may select only one option at any time. Selecting one radio input deselects the others.

Subtitles are optional and should be used to provide more context to the option. Subtitles should be added to all options in the group, or none. Otherwise, alignment will suffer, especially if rendering the options inline.

When a user is able to select multiple options at once use Checkbox.

Order radio options from most likely to least likely to be selected.

When there are 6 or more options consider using a Select.