Skip to main content

Timeline

Rocket 2.0

The Timeline component shows a vertical list of events in order, each with a title, description, time and a colored marker, such as an order's history, an activity feed or an audit trail.

Properties​

Property
Description
Expected Value
ItemsEvents to show, each with a title, and optionally a description, time, status, color and icon. A status such as done, pending, error or current colors the marker.Array
MarkerMarker for each event: a small Dot or the event's Icon in a circle.Dot, Icon. Default: Dot
DensitySpacing between events.Comfortable, Compact. Default: Comfortable
Newest first (reverse)Shows the events in reverse order, so the last item in Items comes first.On or off. Default: Off
TimeWhether each event's time shows to the Right of the title or on Top of it.Right, Top. Default: Right
Date format for ISO times (empty: as given)Format for times given as ISO dates, such as MMM D, h:mm A. Leave empty to show times as given.Text
Colours by statusA color for each status word, for example { "shipped": "#16a34a" }. Overrides the theme's colors.Object
Loading lookWhat shows while the component is loading: a spinner or a skeleton timeline.Spinner, Skeleton. Default: Spinner

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On item clickedTriggers when the user clicks an event.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Clear selectionClears selectedItem.components.timeline1.clearSelection()
Set visibilityShows the component when true, hides it when false.components.timeline1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.timeline1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.timeline1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
itemsEvents to show, each with a title, and optionally a description, time, status, color and icon. A status such as done, pending, error or current colors the marker.{{components.timeline1.items}}
markerMarker for each event: a small Dot or the event's Icon in a circle.{{components.timeline1.marker}}
densitySpacing between events.{{components.timeline1.density}}
newestFirstShows the events in reverse order, so the last item in Items comes first.{{components.timeline1.newestFirst}}
timePositionWhether each event's time shows to the Right of the title or on Top of it.{{components.timeline1.timePosition}}
dateFormatFormat for times given as ISO dates, such as MMM D, h:mm A. Leave empty to show times as given.{{components.timeline1.dateFormat}}
statusColorsA color for each status word, for example { "shipped": "#16a34a" }. Overrides the theme's colors.{{components.timeline1.statusColors}}
loadingIndicatorWhat shows while the component is loading: a spinner or a skeleton timeline.{{components.timeline1.loadingIndicator}}
lastClickedItemThe event the user clicked last. It is kept when the selection is cleared.{{components.timeline1.lastClickedItem}}
selectedItemThe selected event, or an empty object after Clear selection runs or when the event leaves Items.{{components.timeline1.selectedItem}}
isVisibleWhether the component is visible.{{components.timeline1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.timeline1.isLoading}}
isDisabledWhether the component is disabled.{{components.timeline1.isDisabled}}

Styles​

Style
Default
Marker color (items without status)Theme: Brand primary
Connecting line colorTheme: Default border
Title colorTheme: Primary text
Description colorTheme: Placeholder text
Time colorTheme: Placeholder text
Accent (current items)Theme: Brand primary
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.