checked
Description
If true
, the radio will be checked.
Type
boolean
Default
false
Leave Yamada UI a star
StarRadio
is a component used for allowing users to select one option from multiple choices.
Description
If true
, the radio will be checked.
Type
boolean
Default
false
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"
Default
"primary"
Description
If true
, the radio will be initially checked.
Type
boolean
Default
false
Description
If true
, the radio will be initially checked.
Deprecated
Use defaultChecked
instead.
Type
boolean
Default
false
Description
If true
, the form control will be disabled.
Type
boolean
Default
false
Description
Props for icon element.
Type
HTMLUIProps<"span">
Description
id assigned to input.
Type
string
Description
Props for input element.
Type
InputHTMLAttributes<HTMLInputElement>
Description
If true
, the form control will be invalid.
Type
boolean
Default
false
Description
If true
, the radio will be checked.
Deprecated
Use checked
instead.
Type
boolean
Default
false
Description
If true
, the form control will be disabled.
Deprecated
Use disabled
instead.
Type
boolean
Default
false
Description
If true
, the form control will be invalid.
Deprecated
Use invalid
instead.
Type
boolean
Default
false
Description
If true
, the form control will be readonly.
Deprecated
Use readOnly
instead.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Deprecated
Use required
instead.
Type
boolean
Default
false
Description
The label of the radio.
Type
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
Description
Props for label element.
Type
HTMLUIProps<"span">
Description
The name of the input field in a radio.
Type
string
Description
The callback invoked when the checked state changes.
Type
ChangeEventHandler<HTMLInputElement>
Description
If true
, the form control will be readonly.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Type
boolean
Default
false
Description
The size of the Radio.
Type
"sm" | "md" | "lg"
Default
"md"
Description
The value to be used in the radio button.
Type
Y
Description
The variant of the Radio.
Type
string
Description
The CSS align-items
property.
Type
UIValue<AlignItems>
Description
The CSS flex-basis
property.
Type
UIValue<number | "content" | "px" | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | "2xl" | "lg" | "md" | "sm" | "xl" | ({} & string) | (string & {}) | "-moz-fit-content" | ... 69 more ... | "xs">
Description
The initial value of the radio group.
Type
Y
Description
The CSS flex-direction
property.
Type
UIValue<FlexDirection>
Description
If true
, the form control will be disabled.
Type
boolean
Default
false
Description
The CSS flex-grow
property.
Type
UIValue<FlexGrow>
Description
If true
, the form control will be invalid.
Type
boolean
Default
false
Description
If true
, the form control will be disabled.
Deprecated
Use disabled
instead.
Type
boolean
Default
false
Description
If true
, the form control will be invalid.
Deprecated
Use invalid
instead.
Type
boolean
Default
false
Description
If true
, input elements will receive checked
attribute instead of isChecked
.
This assumes, you're using native radio inputs.
Deprecated
It will be deprecated in version 2.0.
Type
boolean
Default
false
Description
If true
, the form control will be readonly.
Deprecated
Use readOnly
instead.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Deprecated
Use required
instead.
Type
boolean
Default
false
Description
If provided, generate radios based on items.
Type
RadioItem<Y>[]
Default
'[]'
Description
The CSS justify-content
property.
Type
UIValue<JustifyContent>
Description
The HTML name
attribute used for forms.
Type
string
Description
The callback fired when any children radio is checked or unchecked.
Type
(value: Y) => void
Description
If true
, the form control will be readonly.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Type
boolean
Default
false
Description
The CSS flex-shrink
property.
Type
UIValue<FlexShrink>
Description
The value of the radio group.
Type
Y
Description
The CSS flex-wrap
property.
Type
UIValue<FlexWrap>
Description
If true
, the radio will be checked.
Type
boolean
Default
false
Description
If true
, the radio will be initially checked.
Type
boolean
Default
false
Description
If true
, the radio will be initially checked.
Deprecated
Use defaultChecked
instead.
Type
boolean
Default
false
Description
If true
, the form control will be disabled.
Type
boolean
Default
false
Description
id assigned to input.
Type
string
Description
If true
, the form control will be invalid.
Type
boolean
Default
false
Description
If true
, the radio will be checked.
Deprecated
Use checked
instead.
Type
boolean
Default
false
Description
If true
, the form control will be disabled.
Deprecated
Use disabled
instead.
Type
boolean
Default
false
Description
If true
, the form control will be invalid.
Deprecated
Use invalid
instead.
Type
boolean
Default
false
Description
If true
, the form control will be readonly.
Deprecated
Use readOnly
instead.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Deprecated
Use required
instead.
Type
boolean
Default
false
Description
The name of the input field in a radio.
Type
string
Description
The callback invoked when the checked state changes.
Type
ChangeEventHandler<HTMLInputElement>
Description
If true
, the form control will be readonly.
Type
boolean
Default
false
Description
If true
, the form control will be required.
Type
boolean
Default
false
Description
The value to be used in the radio button.
Type
Y
Description
The initial value of the radio group.
Type
Y
Description
The top-level id string that will be applied to the radios. The index of the radio will be appended to this top-level id.
Type
string
Description
If true
, input elements will receive checked
attribute instead of isChecked
.
This assumes, you're using native radio inputs.
Deprecated
It will be deprecated in version 2.0.
Type
boolean
Default
false
Description
The HTML name
attribute used for forms.
Type
string
Description
The callback fired when any children radio is checked or unchecked.
Type
(value: Y) => void
Description
The value of the radio group.
Type
Y
Edit this page on GitHub