Leave Yamada UI a star
StarSegmentedControl is a component used for allowing users to select one option from multiple choices.
Description
The visual color appearance of the component.
Type
"whiteAlpha" | "blackAlpha" | "gray" | "neutral" | "red" | "danger" | "rose" | "pink" | "flashy" | "orange" | "warning" | "amber" | "yellow" | "lime" | "green" | "success" | "emerald" | "teal" | "cyan" | "sky" | "blue" | "primary" | "info" | "link" | "indigo" | "violet" | "secondary" | "purple" | "fuchsia"Description
The initial value of the segmented control.
Type
stringDescription
If true, the segmented control will be disabled.
Type
booleanDefault
falseDescription
If true, the segmented control will be readonly.
Type
booleanDefault
falseDescription
If provided, generate segmented control buttons but based on items.
Type
SegmentedControlItem[]Default
'[]'Description
The HTML name attribute used for forms.
Type
stringDescription
The callback fired when any children radio is checked or unchecked.
Type
(value: string) => voidDescription
The size of the SegmentedControl.
Type
"sm" | "md" | "lg"Default
mdDescription
The value of the segmented control.
Type
stringDescription
The variant of the SegmentedControl.
Type
"basic" | "rounded"Default
basicDescription
The value of the segmented control button.
Type
stringDescription
If true, the segmented control will be disabled.
Type
booleanDefault
falseDescription
If true, the segmented control will be readonly.
Type
booleanDefault
falseDescription
Props for motion component.
Type
MotionPropsDescription
The callback fired when any children radio is checked or unchecked.
Type
ChangeEventHandler<HTMLInputElement>Edit this page on GitHub