Skip to content

Timeline

Read-only ordered history composition with semantic marker states; owns no workflow state.

  • Category: Data display
  • 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/timeline.tsx
import { Timeline, TimelineItem } from '@beemvp/beeui-ui';

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

Terminal window
pnpm beeui add timeline

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: Timeline TimelineItem
    • Also routed here, outside the Registry family:
      • timeline
    • Package export subpath: @beemvp/beeui-ui/timeline

Exported types: TimelineItemProps, TimelineProps

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.

Stateless read-only ordered history composition; terminal connector placement is derived automatically from the rendered TimelineItem children, and supplied child keys are preserved — it owns no workflow state.

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.
marker React.ReactNode — Replaces the default status-colored dot in the rail. The rail column is hidden from accessibility regardless.
meta React.ReactNode — Rendered below description in a smaller, subtler style (e.g. a timestamp or actor).
status 'default' | 'primary' | 'success' | 'destructive' 'default' Sets the default marker dot’s color. Ignored when a custom marker is provided. Defaults to 'default'.
title (required) React.ReactNode — The primary heading text for this surface.

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

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.

  • 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.

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: none set in timeline.tsx.
  • Accessibility states and properties it sets: accessibilityElementsHidden — read from timeline.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: status (4 values).
  • 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.

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

  • basic — smallest meaningful complete usage
  • states — the states example

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: Timeline
    • Public composition parts / helpers:
      • TimelineItem
    • Exported type surface:
      • TimelineItemProps
      • TimelineProps

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 Timeline is actually used: 20 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 { DropdownMenu, Popover, Timeline, TimelineItem } from '@beemvp/beeui-ui';
import * as React from 'react';

lines 1022–1041:

<Timeline>
<TimelineItem
description="Core layout, form, navigation, and modal contracts established."
meta="v0.1"
status="success"
title="Foundation"
/>
<TimelineItem
description="Packed packages bundle in Expo and bare React Native; Android APK compiles in CI."
meta="CI verified"
status="success"
title="Native portability"
/>
<TimelineItem
description="Public Popover and DropdownMenu exercise the shared anchored overlay geometry/runtime kernels."
meta="Current"
status="primary"
title="Anchored overlays"
/>
</Timeline>

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.

The terminal-connector flag comes from a context the timeline places around each of its own direct children, so TimelineItems nested inside a wrapper element all inherit that wrapper’s flag instead of their own position, and one rendered outside a Timeline reads the not-last default and draws a connector below itself.