Skip to content

Design system

Documentation

DesignComponents / Timeline

Components / Timeline

Stable

Timeline

Present chronological events with semantic list structure and explicit status markers.

On this page

Examples

Activity history

Order events from oldest to newest and make each event readable without color.

  1. Workspace created

    The initial team workspace is ready.
    Status: success
  2. Members invited

    Three teammates received an invitation.
    Status: current
  3. First review

    The team can add a note before the review.
    Status: default

Workspace activity timeline

Status markers

Pair status color with a text label and event meaning.

  1. Payment captured

    Status: success
  2. Invoice review

    Status: current
  3. Address needs review

    Status: warning
  4. Delivery attempt failed

    Status: error

Timeline status states

Long descriptions

Long content wraps in the event column without covering the timeline rail.

  1. Access review completed

    The security team reviewed access for all workspace members, confirmed role assignments against the current policy, and recorded follow-up for the next quarterly review. This long copy stays within the content column.
    Status: success

Timeline with long event content

Try the timeline

Inspect a concise request history.

  1. Draft saved

    Status: success
  2. Waiting for approval

    Status: current

Timeline property playground

Usage

import { Timeline } from "@phuctech/ui/components/timeline";

<Timeline label="Workspace activity" items={events} />

Timeline renders an ordered vertical list. Event order is exactly the order provided by the feature; date sorting, timezone interpretation, and live updates remain feature-owned.

API

Component API
PropTypeDefaultDescriptionConstraints
labelstringrequiredAccessible name for the ordered history.Use a visible heading or concise label.
itemsreadonly TimelineItem[]requiredChronological event rows with stable IDs.Provide items in the intended reading order.
title / descriptionstring / ReactNoderequired / —The event's primary label and optional detail.Status should also be clear from readable text.
date / dateTimeReactNode / string—Visible timestamp and optional machine-readable value.The component does not convert timezones.
status"default" | "success" | "warning" | "error" | "current""default"Semantic marker styling with a readable status label.Do not rely on marker color alone.
iconReactNodestatus dotOptional decorative event marker.The title and status remain the source of meaning.

Accessibility

Timeline uses a native ordered list, headings, text descriptions, machine-readable times when supplied, and a visually hidden status label. Long descriptions wrap in the event column and the rail is decorative.

  • List presents non-chronological records.
  • Steps presents a workflow's progress rather than past events.