Skip to main content
Version: 1.0.4

ITimelineProps

@spartanfx/react v1.0.4


@spartanfx/react / ITimelineProps

Interface: ITimelineProps

Props for the Timeline component.

Properties

PropertyTypeDescription
animateOnMount?booleanEnable animation on mount
className?stringOptional CSS class for the root element
dateFormatOptions?DateTimeFormatOptionsDate format options for display
endIcon?ReactNodeCustom icon for the end node
endLabel?stringCustom label for end node tooltip
highlightStates?booleanWhen true, applies distinct styling for passed/current/future states
onClick?(step) => voidCallback fired when a step is clicked
orientation?"horizontal" | "vertical"Layout orientation
showDates?booleanWhether to show date labels beneath steps
startIcon?ReactNodeCustom icon for the start node
startLabel?stringCustom label for start node tooltip
stepsTimelineStep[]Array of timeline steps to render