ITimelineEntry

interface
Data Models

Shape of a single timeline data item. Passed via the items prop of OrigamTimeline to render each dot, its optional icon, title, subtitle, and description automatically.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

title
required
string
Primary label rendered next to the timeline dot.
subtitle
string
Secondary label rendered below the title.
description
string
Longer body text rendered below the subtitle.
icon
TIcon
MDI icon name rendered inside the timeline dot.
intent
TIntent
Semantic intent that colors the dot (primary, success, danger, warning, info, neutral).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Timeline driven by an ITimelineEntry array

typescript