Timeline
Timeline visualizes a series of chained events.
Import#
import { Timeline } from 'primereact/timeline';
Basic#
Timeline requires a value for the collection of events and content function that receives an object as a parameter to return content.
<Timeline value={events} content={(item) => item.status} />
Alignment#
Content location relative the line is defined with the align property.
<Timeline value={events} content={(item) => item.status} className="w-full md:w-20rem" />
<Timeline value={events} align="right" content={(item) => item.status} className="w-full md:w-20rem" />
<Timeline value={events} align="alternate" content={(item) => item.status} className="w-full md:w-20rem" />
Opposite#
Additional content at the other side of the line can be provided with the opposite property.
<Timeline value={events} opposite={(item) => item.status}
content={(item) => <small className="text-color-secondary">{item.date}</small>} />
Template#
Sample implementation with custom content and styled markers.
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Inventore sed consequuntur error repudiandae numquam deserunt quisquam repellat libero asperiores earum nam nobis, culpa ratione quam perferendis esse, cupiditate neque quas!
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Inventore sed consequuntur error repudiandae numquam deserunt quisquam repellat libero asperiores earum nam nobis, culpa ratione quam perferendis esse, cupiditate neque quas!
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Inventore sed consequuntur error repudiandae numquam deserunt quisquam repellat libero asperiores earum nam nobis, culpa ratione quam perferendis esse, cupiditate neque quas!
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Inventore sed consequuntur error repudiandae numquam deserunt quisquam repellat libero asperiores earum nam nobis, culpa ratione quam perferendis esse, cupiditate neque quas!
<Timeline value={events} align="alternate" className="customized-timeline"
marker={customizedMarker} content={customizedContent} />
Horizontal#
TimeLine orientation is controlled with the layout property, default is vertical having horizontal as the alternative.
<Timeline value={events} layout="horizontal" align="top" content={(item) => item} />
<Timeline value={events} layout="horizontal" align="bottom" content={(item) => item} />
<Timeline value={events} layout="horizontal" align="alternate" content={(item) => item} opposite={<span> </span>} />
Style#
Following is the list of structural style classes, for theming classes visit theming page.
| Name | Element |
|---|---|
| p-timeline | Container element. |
| p-timeline-left | Container element when alignment is left. |
| p-timeline-right | Container element when alignment is right. |
| p-timeline-top | Container element when alignment is top. |
| p-timeline-bottom | Container element when alignment is bottom. |
| p-timeline-alternate | Container element when alignment is alternating. |
| p-timeline-vertical | Container element of a vertical timeline. |
| p-timeline-horizontal | Container element of a horizontal timeline. |
| p-timeline-event | Event element. |
| p-timeline-event-opposite | Opposite of an event content. |
| p-timeline-event-content | Event content. |
| p-timeline-event-separator | Separator element of an event. |
| p-timeline-event-marker | Marker element of an event. |
| p-timeline-event-connector | Connector element of an event. |
Accessibility#
Screen Reader
Timeline uses a semantic ordered list element to list the events. No specific role is enforced, still you may use any aria role and attributes as any valid attribute is passed to the list element.
Keyboard Support
Component does not include any interactive elements.