Skip to main content

SegmentedField

Forms

SegmentedField — a labelled segmented control with STICKY selection.

import { SegmentedField } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui SegmentedField component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look SegmentedField up before writing code: `npx -y @elabs-ai/components-cli docs SegmentedField` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

5 live examples

Controlled

Clicking Active Segment Is A No Op

Locks the whole reason this component exists: re-clicking the already active segment is a no-op — the value never becomes "" or undefined.

With Disabled Option

Disabled

API

SegmentedField

PropTypeDescription
labelrequiredReactNodeVisible label describing the field.
optionsSegmentedFieldOption[]Segment options. Omit and render `ToggleGroupItem` children directly for the compound-component escape hatch (component-api.md) when a plain `{ value, label }` shape isn't expressive enough.
valuestringControlled selected value.
defaultValuestringUncontrolled initial selected value.
onValueChange(value: string) => voidCalled when the selected value changes. Never called with `""` — re-clicking the active segment (Radix `ToggleGroup`'s `type="single"` empty-emission on re-click) is swallowed as a no-op instead of clearing the field.
size"default" | "sm" | "lg"Size applied to every segment. Defaults to "sm", matching the compact segmented look.
disabledbooleanDisables every segment.
childrenReactNode`ToggleGroupItem` children — the compound escape hatch (used instead of `options`).

Also accepts: Omit< HTMLAttributes<HTMLDivElement>, "onChange" | "defaultValue" >