Skip to main content

The Timeline web component

A content area to display a timeline of events.

Settings

Timeline includes the following configurable options when building apps in the IDE.

FormatShow on desktopShow on mobileMaintain space when hiddenMarginAlways show in edit modeStylesFormat

Properties

All properties for Timeline with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

The displayed date format.


global

boolean

Whether the object is globally scoped for use in all app pages.


groupBy

enum

The grouping option when isGrouped is true.

Values
day

Group items by day.

none

Disable grouping.


boolean

Whether the component is visible.


id

string

The unique identifier.


isGrouped

boolean

Whether to group items.


Whether the component is visible in the desktop layout.


Whether the component is visible in the mobile layout.


items

string[]

The source data.


Whether the component takes up space on the canvas if hidden is true.


The amount of margin to render outside.

Values
4px 8px

Normal margin.

0

No margin.


pending

string

The label to display for pending items when isGrouped is false.


pluginType

string

The plugin type.


renderAsHtml

boolean

Whether to render the text as HTML.


Whether to remain visible in the editor if hidden is true.


sortedDesc

boolean

Whether to sort items in descending order when isGrouped is true.


style

object

Custom style options in use. Not all style options may be available for all components.


The format of the time.


timestamps

string[]

A list of timestamps for each item when isGrouped is true.


Methods

JavaScript API methods for interacting with Timeline. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

timeline.scrollIntoView(scrollIntoViewOptions)
Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values
auto

Scroll immediately to the specified position.

smooth

Scroll gradually to the specified position.


block

enum

The scroll position relative to the component.

Values
nearest

Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.

start

Scrolls to position the component at the top of the visible area.

center

Scrolls to position the component in the middle of the visible area.

end

Scrolls to position the component at the bottom of the visible area.