Skip to content

Timeline

Shows events in a time-ordered sequence.

  1. Latest:

    Design approved

    Final layouts approved for the release.

  2. Feedback addressed

    Navigation and keyboard focus states updated.

  3. Review requested

timeline-demo.tsx

Installation

The CLI adds the files, packages, theme variables, and Tailwind plugin that this component uses. Before you run it, set up your project.

Composition

  • Timeline

    Give it an aria-label.

    • TimelineItemRepeats
      • TimelineTitle
      • TimelineTime

        Set dateTime.

      • TimelineDescriptionOptional

Process

Mark steps that have not happened with status="upcoming". The line to an upcoming step is dashed.

  1. Order placed

  2. Packed

  3. Latest:

    In transit

    The parcel left the Berlin sorting center.

  4. Upcoming:

    Out for delivery

  5. Upcoming:

    Delivered

timeline-process-demo.tsx

Icons

  1. Latest:

    Version 2.4 deployed

  2. Pull request merged

    Adds keyboard reordering to tables.

  3. Review comment

timeline-icons-demo.tsx

API reference

TimelineItem

status: "complete" | "latest" | "upcoming" = "complete"
Sets the marker. Screen readers announce "Latest" or "Upcoming" before the item.
icon: ReactNode
Replaces the check or dot in the marker. Use a 14 pixel icon.

TimelineTitle

as: "h2" | "h3" | "h4" = "h3"
Heading level for the event title.