import {
Timeline,
TimelineContent,Examples
With Left-Aligned Dates
import {
Timeline,
TimelineContent,With Custom Indicators
import {
Timeline,
TimelineContent,With Icons
import {
Timeline,
TimelineContent,Alternating Layout
import {
Timeline,
TimelineDate,Pipeline Steps
import { Badge } from "@/components/reui/badge"
import {
Frame,Dot Indicators
import {
Timeline,
TimelineContent,Horizontal Orientation
import {
Timeline,
TimelineContent,Horizontal with Top Indicators
"use client"
import {Installation
pnpm dlx shadcn@latest add @reui/r-timeline
Usage
import {
Timeline,
TimelineContent,
TimelineDate,
TimelineHeader,
TimelineIndicator,
TimelineItem,
TimelineSeparator,
TimelineTitle,
} from "@/components/reui/r-timeline"<Timeline>
<TimelineItem step={1}>
<TimelineHeader>
<TimelineDate>March 2024</TimelineDate>
<TimelineTitle>Project Initialized</TimelineTitle>
</TimelineHeader>
<TimelineIndicator />
<TimelineSeparator />
<TimelineContent>
Successfully set up the project repository and initial architecture.
</TimelineContent>
</TimelineItem>
</Timeline>API Reference
Timeline
The root component for the timeline.
| Prop | Type | Default | Description |
|---|---|---|---|
defaultValue | number | 1 | The initial active step. |
value | number | - | The current active step (controlled). |
onValueChange | (value: number) => void | - | Callback fired when the active step changes. |
orientation | "horizontal" | "vertical" | "vertical" | The layout orientation of the timeline. |
TimelineItem
A single item in the timeline.
| Prop | Type | Default | Description |
|---|---|---|---|
step | number | - | Required. The step number for this item. |
TimelineDate
The date or time label for a timeline item.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the date label. |
TimelineTitle
The title for a timeline item.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the title. |
TimelineIndicator
The visual indicator (usually a dot) for a timeline item.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the indicator. |
TimelineSeparator
The line connecting timeline indicators.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the separator line. |
TimelineHeader
A container for the date and title.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the header container. |
TimelineContent
The main descriptive content for a timeline item.
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | - | Additional CSS classes for the content container. |
On This Page