Skip to content

Segmented Control

Compact mutually-exclusive selection surface with radiogroup semantics.

  • Category: Actions & controls
  • Status: stable public Registry/export-map component family
  • Targets: iOS · Android · Web, subject to the compatibility contract
  • Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
  • Source: packages/ui/src/components/segmented-control.tsx
import { SegmentedControl, SegmentedControlItem } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

Terminal window
pnpm beeui add segmented-control

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

  • Family exports: SegmentedControl SegmentedControlItem
    • Also routed here, outside the Registry family:
      • segmented-control
    • Package export subpath: @beemvp/beeui-ui/segmented-control

Exported types: SegmentedControlItemProps, SegmentedControlProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

Controlled (value/onValueChange) mutually exclusive selection with radiogroup semantics; enabled usage without onValueChange warns in development, and a disabled segment cannot be selected. accessibilityLabel names the radiogroup for assistive tech; an explicit value always wins, and absent one it falls back to a wrapping Field’s label — the group is never left with the unnamed “radio group” announcement.

Prop Type Default Description
children React.ReactNode — Content rendered inside this element. The family’s composition section states which children it expects.
className string — Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
labelClassName string — Extra utility classes for the label text specifically, merged after the component’s own.
onPress PressableProps['onPress'] — Called before the item’s own selection logic runs, regardless of whether this item is already selected.
value (required) string — Identifies this item; compared against the parent SegmentedControl’s value to determine whether it is selected.

Also carries every prop of Omit<PressableProps, 'accessibilityRole' | 'children' | 'onPress' | 'role'> — that upstream contract is not reproduced here.

Prop Type Default Description
children React.ReactNode — Content rendered inside this element. The family’s composition section states which children it expects.
className string — Extra utility classes, merged after the component’s own via cn(...), so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
disabled boolean false Disables every SegmentedControlItem inside, overriding each item’s own disabled. Defaults to false.
onValueChange (value: string) => void — Called with the newly selected item’s value when a non-selected item is pressed. Required for enabled usage (logs a dev warning otherwise).
value (required) string — The value of the currently selected SegmentedControlItem. Always controlled by the caller — there is no uncontrolled mode.

Also carries every prop of Omit<ViewProps, 'children' | 'role'> — that upstream contract is not reproduced here.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

  • No additional provider is required by this family. BeeUIProvider remains the recommended application root.
  • Peer/native dependencies visible to this Registry item: react, react-native
  • Registry dependency closure: core-cn, text, theme, use-required-callback-warning
  • Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
  • Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

This family ships no platform-specific file, and its own source takes no Platform branch.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

  • Roles this family assigns: radio, radiogroup — set in segmented-control.tsx by the components themselves, not by the caller.
  • Accessibility states and properties it sets: accessibilityLabel, accessibilityLabelledBy, checked, disabled, hidden — read from segmented-control.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

  • Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<PressableProps, 'accessibilityRole' | 'children' | 'onPress' | 'role'>, Omit<ViewProps, 'children' | 'role'>.
  • Class-name surfaces: className, labelClassName.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Each link below opens the Showcase at that exact example, not at the top of the gallery:

  • basic — smallest meaningful complete usage

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

  • Family root / primary export: SegmentedControl
    • Public composition parts / helpers:
      • SegmentedControlItem
    • Exported type surface:
      • SegmentedControlItemProps
      • SegmentedControlProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Segmented Control is actually used: 4 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { SegmentedControl, SegmentedControlItem } from '@beemvp/beeui-ui';
import * as React from 'react';

Fixture state this block reads (same file, line 466):

const [viewMode, setViewMode] = React.useState('list');

lines 927–930:

<SegmentedControl onValueChange={setViewMode} value={viewMode}>
<SegmentedControlItem value="list">List</SegmentedControlItem>
<SegmentedControlItem value="grid">Grid</SegmentedControlItem>
</SegmentedControl>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

A press on the already-selected item changes nothing: onValueChange fires only for an item that is not selected. An item’s own onPress runs first but cannot cancel the selection that follows it.