GC Design System Components Installation Page templates Contact us Get involved Find a demo GC Design System Components

Radio Group
<gcds-radio-group>

Also called: radio button, radio.

The radio group is a set of options for a single selection.

Radio group component preview

Build a radio group

Use a radio group with a fieldset when you're expecting a person to select only one option from a short list of responses.

The radio group helps a person to make a choice by limiting their options.

Coding and accessibility for radio group

Apply required attributes

For the radio group to function properly, always use the following attributes with <gcds-radio-group>:

Use the options attribute with radio group

The options attribute takes an array of objects to render each radio button. The following is an example of one of the objects:

{
'id'!: '',
'label'!: '',
'value'!: '',
'required'?: '',
'disabled'?: '',
'checked'?: '',
'hint'?: '',
}

Get your code

Generate an instance of the component you need by selecting its code properties.

  1. Explore by choosing different code values to generate the instance you want.

  2. Get the code and pull it into your environment.

  3. Add any copy you need to the component (like text for a label).

Note: The code builder uses English for all code elements, which follows standard practice.

Help us improve

Have questions or a request? Give feedback on our contact form.

Something's wrong? Raise it through GitHub with an account. You'll have access to the team's direct responses, progress made on your issue, and issues raised by others.

Give feedback Report an issue on GitHub
2024-05-08