ITimelineProps

interface
Component Props

Full props contract for <OrigamTimeline>. Supports vertical and horizontal orientations, data-driven rendering via items, side alignment, and the full color/size/density surface.

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.

items
ITimelineEntry[]
Data array driving automatic item rendering. Each entry maps to an OrigamTimelineItem.
orientation
TTimelineOrientation
Layout direction: vertical (default, top to bottom) or horizontal (left to right with scroll-snap).
side
TTimelineSide
Default side for item content relative to the connector line.
truncateLine
boolean
Hide the trailing connector line after the last item.
ariaLabel
string
Accessible label for the timeline landmark (aria-label on the root element).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Horizontal timeline with alternating sides

vue