value
RequiredDescription
The value of the segmented control button.
Type
string
Leave Yamada UI a star
StarSegmentedControl
is a component used for allowing users to select one option from multiple choices.
Description
The value of the segmented control button.
Type
string
Description
If true
, the segmented control will be disabled.
Type
boolean
Default
false
Description
If true
, the segmented control will be disabled.
Deprecated
Use disabled
instead.
Type
boolean
Default
false
Description
If true
, the segmented control will be readonly.
Deprecated
Use readOnly
instead.
Type
boolean
Default
false
Description
Props for motion component.
Type
MotionProps
Description
The callback fired when any children radio is checked or unchecked.
Type
ChangeEventHandler<HTMLInputElement>
Description
If true
, the segmented control will be readonly.
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"
Description
The initial value of the segmented control.
Type
string
Description
If true
, the segmented control will be disabled.
Type
boolean
Default
false
Description
If true
, the segmented control will be disabled.
Deprecated
Use disabled
instead.
Type
boolean
Default
false
Description
If true
, the segmented control will be readonly.
Deprecated
Use readOnly
instead.
Type
boolean
Default
false
Description
If provided, generate segmented control buttons but based on items.
Type
SegmentedControlItem[]
Default
'[]'
Description
The HTML name
attribute used for forms.
Type
string
Description
The callback fired when any children radio is checked or unchecked.
Type
(value: string) => void
Description
If true
, the segmented control will be readonly.
Type
boolean
Default
false
Description
The size of the SegmentedControl.
Type
"sm" | "md" | "lg"
Default
"md"
Description
The value of the segmented control.
Type
string
Description
The variant of the SegmentedControl.
Type
"basic" | "rounded"
Default
"basic"
Edit this page on GitHub