Stepper

Controlled current-step context with finite normalization and duplicate-step fail-safe; owns no workflow state.

Distribution status

BeeUI 0.86.2-rc.3 is public on npm under the opt-in next dist-tag (observed 2026-09-25T06:25:18.371Z). latest currently resolves to 0.86.2-rc.3 and lags next until the owner moves it for all four packages. See Start for the full install commands. The import shape below works against the published package; the repository-local Registry command remains available as a no-registry-required alternative from a BeeUI checkout. Pin @0.86.2-rc.3 instead of @next for an immutable version in CI.

Identity

• Category: Navigation & disclosure
• 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/stepper.tsx

Import

import { Stepper, StepperItem } from '@beemvp/beeui-ui';

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

pnpm beeui add stepper

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.

Composition and public API

• Family exports: Stepper StepperItem
  • Also routed here, outside the Registry family:
    • stepper
  • Package export subpath: @beemvp/beeui-ui/stepper

Exported types: StepperItemProps, StepperProps

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.

State and behavior contract

Controlled currentStep context shared with every StepperItem; step values are normalized to a finite range, and a StepperItem sharing a duplicate normalized step value fails safe as disabled — it owns no application workflow state. orientation ('vertical' default, or 'horizontal') is a pure layout switch — it changes the connector line direction only, not the step-normalization or fail-safe behavior above.

Props

StepperItemProps

Prop	Type	Default	Description
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.
description	React.ReactNode	—	Secondary supporting text rendered beneath the primary label or title.
step (required)	number	—	This item’s position, 1-based (never 0-based). Non-finite values, and values below 1 (including 0), are floored and clamp up to 1 with a dev-mode warning. Compared against the parent Stepper’s currentStep to determine current/complete state. A value duplicated by another item is disabled with a separate dev-mode warning.
title (required)	React.ReactNode	—	The primary heading text for this surface.

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

StepperProps

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.
currentStep (required)	number	—	The active step number, 1-based (never 0-based) and clamped to [1, number of StepperItem children]. Non-finite values, and values below 1 (including 0), fall back to/clamp up to 1 with a dev-mode warning.
disabled	boolean	false	Disables every StepperItem inside, overriding each item’s own disabled. Defaults to false.
onStepChange	(step: number) => void	—	Called with a step’s normalized step number when a non-disabled StepperItem is pressed. Also required (alongside a per-item onPress) for any item to render as interactive.
orientation	'horizontal' | 'vertical'	'vertical'	Lays items out as a horizontal row (e.g. a desktop onboarding wizard) instead of the default vertical stack. Defaults to 'vertical'.

Also carries every prop of Omit<ViewProps, 'children'> — 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.

Provider and dependencies

• 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: box, core-cn, text, theme
• 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.

Platform behavior

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.

Accessibility

• Roles this family assigns: button — set in stepper.tsx by the components themselves, not by the caller.
• Accessibility states and properties it sets: accessibilityLabel, accessible, current, disabled, selected, text — read from stepper.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.

Styling and theming

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

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.

Executable examples

• Primary executable fixture: apps/showcase/__tests__/application-primitives.test.tsx
• Additional fixture: apps/showcase/__tests__/issue-7-state-edge-cases.test.tsx
• Additional fixture: apps/showcase/__tests__/stepper-current-title-contrast.test.tsx
• Additional fixture: apps/showcase/__tests__/stepper-orientation-and-step-clamp-warning.test.tsx

Addressable examples

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.

Live Web preview

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.

Composition anatomy

• Family root / primary export: Stepper
  • Public composition parts / helpers:
    • StepperItem
  • Exported type surface:
    • StepperItemProps
    • StepperProps

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.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Stepper is actually used: 5 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 { Stepper, StepperItem } from '@beemvp/beeui-ui';
import * as React from 'react';

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

  const [step, setStep] = React.useState(3);

lines 1004–1008:

                  <Stepper currentStep={step} onStepChange={setStep} testID="stepper-showcase">
                    <StepperItem step={1} title="Foundation" />
                    <StepperItem step={2} title="Application patterns" />
                    <StepperItem step={3} title="Overlays" />
                  </Stepper>

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.

Limitations

The step total each item announces is the number of the stepper’s own direct children, so wrapping items in another element miscounts it, and the announced string is an English literal. A StepperItem throws when rendered outside a Stepper.

Related

• All components
• Production patterns
• Showcase
• CLI & source ownership
• Source