Skip to content
On this page

Properties

activeItemIndex

Selects the active timeline item on load.

allowDynamicUpdate

Allows timeline items to be updated dynamically.

borderLessCards

Removes the border & shadow from the timeline cards.

cardHeight

Sets the minimum height of the timeline card.

cardLess

Disables timeline cards on both horizontal and vertical modes.

cardPositionHorizontal

Positions the card in HORIZONTAL mode. can be either TOP or BOTTOM.

cardWidth

Sets the maximum width of the timeline card.

disableAutoScrollOnClick

Disables the timeline from auto-scrolling when a timeline card is clicked.

disableClickOnCircle

Disables click action on the circular points.

disableNavOnKey

Disables keyboard navigation.

enableOutline

Enables the outline menu on VERTICAL and VERTICAL_ALTERNATING mode.

flipLayout

Flips the layout (RTL).

hideControls

Hides the navigation controls.

itemWidth

Width of the timeline section in HORIZONTAL mode.

items

Collection of Timeline Item Model.

lineWidth

Prop to customize the width of the timeline track line.

mode

Sets the mode of the component. can be HORIZONTAL, VERTICAL or VERTICAL_ALTERNATING.

onItemSelected

Callback invoked on a item selection. passes all of the data pertinent to the item.

onScrollEnd

Use the onScrollEnd to detect the end of the timeline.

scrollable

Makes the timeline scrollable (applicable for VERTICAL & VERTICAL_ALTERNATING).

showAllCardsHorizontal

In horizontal mode, only the active card is displayed. With this prop, you can display all the cards.

slideItemDuration

Duration (in ms), the timeline card is active during a slideshow.

slideShow

Enables the slideshow control.

theme

Prop to customize the colors.

timelineCircleDimension

Dimensions of the circular points on the timeline.

useReadMore

Enables or disables the "read more" button. The "read more" button is only available if the text content on the card is taller than the card itself.

fontSizes

property to customize the font sizes

buttonTexts

Customize the alt text for all buttons.

Released under the MIT License.