ITimelineProps

@spartanfx/react v1.2.2

---

@spartanfx/react / index / ITimelineProps

Interface: ITimelineProps

Props for the Timeline component.

Properties

Required

Property	Type	Description
steps	TimelineStep[]	Array of timeline steps to render

Options

Property	Type	Description
animateOnMount?	boolean	Enable animation on mount
dateFormatOptions?	DateTimeFormatOptions	Date format options for display
endIcon?	ReactNode	Custom icon for the end node
endLabel?	string	Custom label for end node tooltip
highlightStates?	boolean	When true, applies distinct styling for passed/current/future states
orientation?	"horizontal" | "vertical"	Layout orientation
showDates?	boolean	Whether to show date labels beneath steps
startIcon?	ReactNode	Custom icon for the start node
startLabel?	string	Custom label for start node tooltip

Events & callbacks

Property	Type	Description
onClick?	(step) => void	Callback fired when a step is clicked

Appearance & theming

Property	Type	Description
className?	string	Optional CSS class for the root element