Skip to Content
DocsResourcesShowcase

Segmented Control

Used to pick one choice from a linear set of options

SourceStorybookRecipeArk

import { SegmentedControl } from '@saas-ui/react/segmented-control'
<SegmentedControl items={[]} />

Use the size prop to change the size of the segmented control.

size = xs

size = sm

size = md

size = lg

Use the value and onValueChange props to control the selected item.

Here's an example of how to use the SegmentedControl with react-hook-form.

Use the disabled prop to disable the segmented control.

Use the disabled prop on the item to disable it.

Render the label as a ReactNode to render an icon.

Here's an example of how to use the SegmentedControl within a Card.

Find your dream home

PropDefaultType
colorPalette 'gray'
'gray' | 'red' | 'orange' | 'yellow' | 'green' | 'teal' | 'blue' | 'cyan' | 'purple' | 'pink' | 'accent'

The color palette of the component

size 'md'
'sm' | 'md' | 'lg'

The size of the component

asChild
boolean

Use the provided child element as the default rendered element, combining their props and behavior.

For more details, read our Composition guide.
defaultValue
string

The initial value of the segment group when it is first rendered. Use when you do not need to control the state of the segment group.

disabled
boolean

If `true`, the radio group will be disabled

form
string

The associate form of the underlying input.

id
string

The unique identifier of the machine.

ids
Partial<{ root: string label: string indicator: string item(value: string): string itemLabel(value: string): string itemControl(value: string): string itemHiddenInput(value: string): string }>

The ids of the elements in the radio. Useful for composition.

name
string

The name of the input fields in the radio (Useful for form submission).

onValueChange
(details: ValueChangeDetails) => void

Function called once a radio is checked

orientation
'horizontal' | 'vertical'

Orientation of the radio group

readOnly
boolean

Whether the checkbox is read-only

value
string

The value of the checked radio

Previous

Rating

Next

Select (Native)