@molecule/app-order-timeline-react

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

Order / shipment progress timeline.

Exports <OrderTimeline> and OrderMilestone type.

Quick Start

import { OrderTimeline, type OrderMilestone } from '@molecule/app-order-timeline-react'

const milestones: OrderMilestone[] = [
  { id: 'placed', label: 'Order placed', completed: true },
  { id: 'shipped', label: 'Shipped', completed: true, detail: 'Jun 3 via FedEx' },
  { id: 'delivery', label: 'Out for delivery', current: true },
  { id: 'delivered', label: 'Delivered' },
]

<OrderTimeline milestones={milestones} eta="Estimated arrival: today by 8 pm" />

Type

feature

Installation

npm install @molecule/app-order-timeline-react @molecule/app-react @molecule/app-ui @molecule/app-ui-react react
npm install -D @types/react

API

Interfaces

`OrderMilestone`

A single step in an order or shipment progress timeline.

interface OrderMilestone {
  id: string
  /** Display label ("Placed", "Shipped", "Delivered"). */
  label: ReactNode
  /** Optional description / timestamp / location. */
  detail?: ReactNode
  /** Is this milestone completed? */
  completed?: boolean
  /** Is this the current (in-progress) milestone? */
  current?: boolean
}

`OrderTimelineProps`

Props for {@link OrderTimeline}.

interface OrderTimelineProps {
  milestones: OrderMilestone[]
  /** Optional ETA / summary line. */
  eta?: ReactNode
  /** Layout orientation. */
  orientation?: 'horizontal' | 'vertical'
  /** Extra classes. */
  className?: string
}

Functions

`OrderTimeline(props)`

Order / shipment progress timeline — typical e-commerce flow: "Placed → Confirmed → Shipped → Out for delivery → Delivered".

Different from <Stepper> in two ways:

Focuses on milestones (with optional per-step detail) rather than multi-page wizard steps.
Horizontal layout is responsive with connector lines between nodes.

function OrderTimeline({
  milestones,
  eta,
  orientation = 'horizontal',
  className,
}: OrderTimelineProps): JSX.Element

props — Component props (see {@link OrderTimelineProps}).

Injection Notes

Requirements

Peer dependencies:

@molecule/app-react ^1.0.1
@molecule/app-ui ^1.0.1
@molecule/app-ui-react ^1.0.1
react ^18.0.0 || ^19.0.0

Runtime Dependencies

@molecule/app-react
@molecule/app-ui
@molecule/app-ui-react
react

Requires a wired ClassMap bond — getClassMap() throws before wiring.

All strings (label, detail, eta) are caller-provided — resolve them through your app's t() before passing so the timeline localizes.

Status node colors are currently fixed hex values (blue = current, green = completed, gray = pending) rather than theme variables — the pending gray has low contrast on dark surfaces. completed and current are independent booleans: mark every finished milestone completed: true and exactly one in-progress milestone current: true; a milestone with neither renders as pending.

`@molecule/app-order-timeline-react`

How it works

Reference