addon
Description
The addon of the radio card.
Type
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
Leave Yamada UI a star
StarRadioCard
is a component used for allowing users to select one option from multiple choices.
Description
The addon of the radio card.
Type
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
Description
Props for the footer of the radio card.
Type
RadioCardAddonProps
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
The body of the radio card.
Type
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
Description
Props for the description of the radio card.
Type
RadioCardDescriptionProps
Description
If true
, the form control will be disabled.
Type
boolean
Default
false
Description
Props for the icon of the radio card.
Type
HTMLUIProps
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 card.
Type
type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
Description
Props for the label of the radio card.
Type
RadioCardLabelProps
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 RadioCard.
Type
"sm" | "md" | "lg"
Default
"md"
Description
The value to be used in the radio button.
Type
Y
Description
The variant of the RadioCard.
Type
"outline" | "subtle" | "surface"
Default
"outline"
Description
If true
, the icon will be displayed.
Type
boolean
Default
true
Description
Props for the footer of the radio card.
Type
RadioCardAddonProps
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
Props for the description of the radio card.
Type
RadioCardDescriptionProps
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 radio cards based on items.
Type
RadioCardItem<Y>[]
Default
'[]'
Description
The CSS justify-content
property.
Type
UIValue<JustifyContent>
Description
Props for the label of the radio card.
Type
RadioCardLabelProps
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
If true
, the icon will be displayed.
Type
boolean
Default
true
Description
The CSS flex-wrap
property.
Type
UIValue<FlexWrap>
Description
The props for the label content.
Type
HTMLUIProps<"span">
Description
The props for the icon.
Type
HTMLUIProps
Description
If true
, the icon will be displayed.
Type
boolean
Default
true
Edit this page on GitHub