structyl

Timeline

stable

A chronological event list.

Basic usage

  1. Created project

Examples

Multiple events

Compose separators, dots and content for chronological activity.

  1. Created project
  2. Invited team
  3. Deployed preview

Custom dot states

Customize dot color with token classes for status timelines.

  1. Checks passed
  2. Review pending

Position and dot variants

Timeline supports position plus filled/outlined colored dots.

  1. Passed
  2. Pending

Features

  • Compound timeline parts.
  • Styled dot and content.

Installation

bash
pnpm dlx structyl add timeline

API Reference

Timeline.Root

Timeline list root.

PropTypeDefault
position'left' | 'right' | 'alternate'

Timeline content position.

'right'
classNamestring

Additional Tailwind classes merged with the component defaults.

Timeline.Dot

Timeline marker.

PropTypeDefault
color'default' | 'primary' | 'secondary' | 'success' | 'warning' | 'destructive' | 'muted'

Marker color.

'primary'
variant'filled' | 'outlined'

Marker treatment.

'filled'
classNamestring

Additional Tailwind classes merged with the component defaults.

Timeline.Item / Separator / Content

Timeline composition parts.

PropTypeDefault
classNamestring

Additional Tailwind classes merged with the component defaults.

Timeline | structyl