ITimelineContext
interface
Component Context
Context object provided by OrigamTimeline to its nested OrigamTimelineItem children via inject. Carries the parent layout direction and shared visual props without requiring explicit prop forwarding.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- siderequiredTTimelineSide
- Layout side for item content: left of the dot (start), right of the dot (end), or alternating.
- truncateLinerequiredboolean
- Whether to truncate (hide) the connecting line after the last item.
- orientationrequiredTTimelineOrientation
- Layout direction of the timeline: vertical (top to bottom) or horizontal (left to right).
- colorstring
- Shared dot/line color inherited by all child items unless overridden per item.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Injecting timeline context in a child item