Timeline

Design System - Timeline component

The Timeline component visually represents a sequence of events or stages in a linear, chronological order. Designed with clarity and accessibility in mind, it helps users understand the progress, status, and associated actions within a workflow.

Component React

// Sample code

<Timeline
      label="Upcoming Timeline Step3"
      subElements={subElements}
      variant="upcoming"
      showConnector={true}
    />

Component Flutter

Component Design

Anatomy

---

Variants

---

	Upcoming Displays future events or steps in the process. The visual indicator is muted to reflect inactivity, and it can include relevant date/time info.
	In Progress Represents tasks or stages currently underway. It uses an active visual indicator to denote ongoing status and may include interactive elements like “View Details”.
	Completed Marks finished tasks using a filled, completed icon. This variant reinforces a sense of progression and task completion.

---

Properties

Default Shows only the stage name without additional data, keeping the interface clean.
Date Includes the date beneath the stage to inform users of timing for events or steps.
Additional Elements Enhances the component with date/time details and a collapsible “View Details” element, which opens further content.
Expanded Displays rich content such as text blocks, image/document previews, and action buttons to support user interaction.
Error Timeline Highlights failed or incomplete steps with red indicators and messaging like “Failed”, drawing attention to issues that require user attention.

Property Configuration Table

Each design component offers a range of configurable options. These options are intentionally platform-agnostic, allowing implementations to adapt and tailor them to align with the specific requirements of the chosen framework.

React

Property	Value	Default
label	text
subElements	text
variant	yes/no	no
viewDetailsLabel	yes/no	no
hideDetailsLabel	number
additionalElements	yes/no
inline	yes/no	no
individualElementStyles	yes/no	no
showConnector	yes/no	no
className	number	no
isLabelFirst	yes/no	no
isNextActiveStep	text	no
showDefaultValueForDate	yes/no	no
isError	yes/no
initialVisibleAdditionalElementsCount	yes/no

Flutter

---

Behaviours

	Progressive Expansion Sections expand to reveal additional information, files, and actions only when the user chooses to explore, preventing visual clutter.

---

Usage Guide

---

Ensure Clear Status Representation Each timeline status should be visually distinct using clear colours, icons, and typography so that users can easily understand the progression and current state. Icons should clearly match their status. Avoid using similar icons for different statuses, which can lead to misinterpretation.

Changelog

---

Date	Number	Notes
Dec 15, 2024	v-0.0.2	This component is added to the website. This component is now individually versioned.

Design Checklist

---

	All interactive states - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).
	Accessible use of colours - Colour is not used as the only visual means of conveying information (WCAG 2.1 1.4.1)
	Accessible contrast for text - Text has a contrast ratio of at least 4.5:1 for small text and at least 3:1 for large text (WCAG 2.0 1.4.3).
	Accessible contrast for UI components - Visual information required to identify components and states (except inactive components) has a contrast ratio of at least 3:1 (WCAG 2.1 1.4.11).
	Keyboard interactions - Includes all interactive states that are applicable (hover, down, focus, keyboard focus, disabled).
	Screen reader accessible - All content, including headings, labels, and descriptions, is meaningful, concise, contextual and accessible by screen readers.
	Responsive for all breakpoints - Responsiveness for 3 breakpoints - Mobile, Tablet and Desktop
	Usage guidelines - Includes a list of dos and don'ts that highlight best practices and common mistakes.
	Writing guidelines - Content standards and usage guidelines for writing and formatting in-product content for the component.
	Defined variants and properties - Includes relevant variants and properties (style, size, orientation, optional iconography, decorative elements, selection states, error states, etc.)
	Defined behaviours - Guidelines for keyboard navigation and focus, layout management (including wrapping, truncation, and overflow), animations, and user interactions.
	Design Kit - Access to the design file for the component in Figma, multiple options, states, colour themes, and platform scales.