Radio
<wa-radio>
Radios allow the user to select a single option from a group.
This component must be used as a child of <wa-radio-group>. Please see the Radio Group docs to see examples of this component in action.
Importing
Jump to heading
Autoloading components via projects is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.
Let your project code do the work! Sign up for free to use a project with your very own CDN — it's the fastest and easiest way to use Web Awesome.
To manually import this component from NPM, use the following code.
import '@awesome.me/webawesome/dist/components/radio/radio.js';
To manually import this component from React, use the following code.
import WaRadio from '@awesome.me/webawesome/dist/react/radio';
Slots
Jump to heading
Learn more about using slots.
| Name | Description |
|---|---|
| (default) | The radio's label. |
Attributes & Properties
Jump to heading
Learn more about attributes and properties.
| Name | Description | Reflects | |
|---|---|---|---|
appearanceappearance |
The radio's visual appearance.
Type
'default' | 'button'Default
'default' |
|
|
css |
One or more CSSResultGroup to include in the component's shadow root. Host styles are automatically prepended.
Type
CSSResultGroup | undefinedDefault
[formControlStyles, sizeStyles, styles] |
||
customStates |
Methods for setting and checking custom states.
Type
objectDefault
{ /** Adds or removes the specified custom state. / set: (customState: string, active: boolean) => { if (!Boolean(this.internals?.states)) return; try { if (active) { this.internals.states.add(customState); } else { this.internals.states.delete(customState); } } catch (e) { if (String(e).includes("must start with '--'")) { / eslint-disable-next-line / console.error('Your browser implements an outdated version of CustomStateSet. Consider using a polyfill'); } else { throw e; } } }, /* Determines whether or not the element currently has the specified state. */ has: (customState: string) => { if (!Boolean(this.internals?.states)) return false; try { return this.internals.states.has(customState); } catch { return false; } }, } |
||
disableddisabled |
Disables the radio.
Type
booleanDefault
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.Type
HTMLFormElement | null |
||
namename |
The name of the input, submitted as a name/value pair with form data.
Type
string | nullDefault
null |
|
|
sizesize |
The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this
attribute can typically be omitted.
Type
'small' | 'medium' | 'large'Default
'medium' |
|
|
validationTarget |
Override this to change where constraint validation popups are anchored.
Type
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.Type
Validator[]Default
[] |
||
valuevalue |
The radio's value. When selected, the radio group will receive this value.
Type
string |
|
Methods
Jump to heading
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'
|
relayNativeEvent() |
Given a native event, this function cancels it and dispatches it again from the host element using the desired event options. |
event: Event,
eventOptions: EventInit
|
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
Jump to heading
Learn more about events.
| Name | Description |
|---|---|
blur |
Emitted when the control loses focus. |
focus |
Emitted when the control gains focus. |
CSS custom properties
Jump to heading
Learn more about CSS custom properties.
| Name | Description |
|---|---|
--checked-icon-color |
The color of the checked icon.
|
--checked-icon-scale |
The size of the checked icon relative to the radio.
|
Custom States
Jump to heading
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
Jump to heading
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
Jump to heading
This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.
Need a hand?