Radios
<gcds-radios>

Also called: radio button, radio.

Radios provide a set of options for a single response.

• GitHub
• Figma

Build radios

Use radios when you're expecting a person to select only one option from a short list of responses.

Radios help a person to make a choice by limiting their options.

Coding and accessibility for radios

Apply required attributes

For the radios to function properly, always use the following attributes with gcds-radios:

• name
• legend
• options

Use the options attribute with radios

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'!: '',
  'checked'?: '',
  'hint'?: '',
}

Within the options attribute, always use the object’s id, label and value properties for each radio button. The rest of the properties are optional.

Use the value attribute

The value attribute provides a quick reference to the values of the checked radio button inside the gcds-radios component.

Handle error messages and validation

• Use the required attribute to activate the required validator. Validation will happen by default on the onBlur event. A missing or invalid entry will prompt an inline error message with preset text.

• If you need to change the validation event, use the validate-on attribute. Validation can happen on blur, when the element loses focus, or manually with the validate() method.

• Use the required attribute for fields that must be filled in. This places "required" at the end of the label.

• Use the error-message attribute to include an error message text for all required inputs. Avoid using error messages for optional ones.

• For optional fields, avoid adding the error-message attribute.

• For an optional field that needs validation based on user input (like validating an email address format), opt to add custom validation with a custom error message.

Include hint text for task success

Use the hint attribute or the hint key in the options object to add hint text to help a person choose an input and avoid an error state.

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.