Radio
<cs-radio>
Radios represent a single option within a mutually exclusive set. Use them inside a radio group when users must pick exactly one choice from a small list.
This component must be used as a child of <cs-radio-group>. Please see the Radio Group docs to see examples of this component in action.
API
Importing
If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.
import '@cruglobal/cornerstone-components/components/radio/radio.js';
import './cornerstone/components/radio/radio.js';
import CsRadio from '@cruglobal/cornerstone-components/react/radio/index.js';
Slots
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The radio's label. |
Attributes & Properties
Learn more about attributes and properties.
| Property | Attribute | Description | Type | Default | Reflects |
|---|---|---|---|---|---|
appearance | appearance | The radio's visual appearance. | 'default' | 'button' | 'default' | Yes |
disabled | disabled | Disables the radio. | boolean | false | — |
form | — | By default, form controls are associated with the nearest containing <form> element. This attribute allows you to place the form control outside of a form and associate it with the form that has this id. The form must be in the same document or shadow root for this to work. | HTMLFormElement | null | — | — |
name | name | The name of the input, submitted as a name/value pair with form data. | string | null | null | Yes |
size | size | The radio's size. When used inside a radio group, the size will be determined by the radio group's size, which will override this attribute. | 'xs' | 's' | 'm' | 'l' | 'xl' | — | Yes |
validationTarget | — | Override this to change where constraint validation popups are anchored. | undefined | HTMLElement | — | — |
validators | — | Validators are static because they have observedAttributes, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator. | Validator[] | [] | — |
value | value | The radio's value. When selected, the radio group will receive this value. | string | — | Yes |
Methods
Learn more about methods.
| Name | Description | Arguments |
|---|---|---|
formStateRestoreCallback() | Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue. | state: string | File | FormData | null, reason: 'autocomplete' | 'restore' |
resetValidity() | Reset validity is a way of removing manual custom errors and native validation. | — |
setCustomValidity() | Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators. | message: string |
Events
Learn more about events.
| Name | Description |
|---|---|
blur | Emitted when the control loses focus. |
focus | Emitted when the control gains focus. |
CSS Custom Properties
Learn more about CSS custom properties.
| Name | Description | Default |
|---|---|---|
--checked-icon-color | The color of the checked icon. | — |
--checked-icon-scale | The size of the checked icon relative to the radio. | — |
Custom States
Learn more about custom states.
| Name | Description | CSS selector |
|---|---|---|
checked | Applied when the control is checked. | :state(checked) |
disabled | Applied when the control is disabled. | :state(disabled) |
CSS Parts
Learn more about CSS parts.
| Name | Description | CSS selector |
|---|---|---|
checked-icon | The checked icon. | ::part(checked-icon) |
control | The circular container that wraps the radio's checked state. | ::part(control) |
label | The container that wraps the radio's label. | ::part(label) |
Dependencies
This component automatically imports the following elements. Sub-dependencies, if any exist, are included in this list.