ITimelineItemProps

interface
Component Props

Props contract for <OrigamTimelineItem>. Carries the per-item visual and layout configuration including title, subtitle, icon, intent, and layout context inherited from the parent OrigamTimeline.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

title
string
Primary label rendered next to the timeline dot.
subtitle
string
Secondary label rendered below the title.
description
string
icon
TIcon
MDI icon name rendered inside the timeline dot.
intent
TIntent
Semantic intent that colors the dot (primary, success, danger, warning, info, neutral).
isLast
boolean
Whether this is the last item in the timeline. Hides the trailing connector line when true.
truncateLine
boolean
Inherited from the parent context. When true the last connecting line is hidden.
side
TTimelineSide
Layout side for content: left, right, or alternating. Inherited from parent context.
orientation
TTimelineOrientation
Layout direction forwarded by the parent OrigamTimeline. Defaults to vertical when unset.
index
number
Zero-based position of this item in the parent items array. Used to compute alternating side.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Standalone timeline item with intent

vue