react-chrono
Advanced tools
// install with yarn
yarn add react-chrono
// or with npm
npm install react-chrono
Please make sure you wrap the component in a container that has a width and height.
When no mode is specified, the component defaults to HORIZONTAL mode. Please check props for all the available options.
import React from "react"
import { Chrono } from "react-chrono";
const Home = () => {
const items = [{
title: "May 1940",
cardTitle: "Dunkirk",
url: "http://www.history.com",
cardSubtitle:"Men of the British Expeditionary Force (BEF) wade out to..",
cardDetailedText: "Men of the British Expeditionary Force (BEF) wade out to..",
media: {
type: "IMAGE",
source: {
url: "http://someurl/image.jpg"
}
}
}, ...];
return (
<div style={{ width: "500px", height: "400px" }}>
<Chrono items={items} />
</div>
)
}
To render the timeline vertically use the VERTICAL mode
<div style={{ width: '500px', height: '950px' }}>
<Chrono items={items} mode="VERTICAL" />
</div>
In VERTICAL_ALTERNATING mode the timeline is rendered vertically with cards alternating between left and right side.
<div style={{ width: '500px', height: '950px' }}>
<Chrono items={items} mode="VERTICAL_ALTERNATING" />
</div>
Play the timeline automatically with the slideShow mode. This prop enables the play button on the ui controls.
<div style={{ width: '500px', height: '950px' }}>
<Chrono items={items} slideShow mode="VERTICAL_ALTERNATING" />
</div>
| name | description | default |
|---|---|---|
| activeItemIndex | Selects the active timeline item on load. | 0 |
| allowDynamicUpdate | Allows timeline items to be updated dynamically. | false |
| borderLessCards | Removes the border & shadow from the timeline cards. | false |
| buttonTexts | Customize the alt text for all buttons | |
| cardHeight | Sets the minimum height of the timeline card. | 200 |
| cardLess | Disables timeline cards on both horizontal and vertical modes. | false |
| 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. | false |
| disableClickOnCircle | Disables click action on the circular points. | false |
| disableNavOnKey | Disables keyboard navigation. | false |
| enableOutline | Enables the outline menu on VERTICAL and VERTICAL_ALTERNATING mode. | false |
| flipLayout | Flips the layout (RTL). | false |
| focusActiveItemOnLoad | Setting this to true automatically scrolls and focuses the activeItemIndex on load | false |
| fontSizes | property to customize the font sizes | |
| hideControls | Hides the navigation controls. | false **** |
| itemWidth | Width of the timeline section in HORIZONTAL mode. | 300 |
| items | Collection of Timeline Item Model. | [] |
| lineWidth | Prop to customize the width of the timeline track line. | 3px |
| mode | Sets the mode of the component. can be HORIZONTAL, VERTICAL or VERTICAL_ALTERNATING. | 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). | true |
| showAllCardsHorizontal | In horizontal mode, only the active card is displayed. With this prop, you can display all the cards. | false |
| slideItemDuration | Duration (in ms), the timeline card is active during a slideshow. | 5000 |
| slideShow | Enables the slideshow control. | false |
| theme | Prop to customize the colors. | |
| timelineCircleDimension | Dimensions of the circular points on the timeline | false |
| 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. | true |
react-chrono supports three modes HORIZONTAL, VERTICAL and VERTICAL_ALTERNATING. No additional setting is required.
<Chrono items={items} mode="HORIZONTAL" />
<Chrono items={items} mode="VERTICAL" />
<Chrono items={items} mode="VERTICAL_ALTERNATING" />
| name | description | type |
|---|---|---|
| title | title of the timeline item | String |
| cardTitle | title that is displayed on the timeline card | String |
| cardSubtitle | text displayed in the timeline card | String |
| cardDetailedText | detailed text displayed in the timeline card | String or String[] |
| media | media object to set image or video. | Object |
| url | url to be used in the title. | String |
{
title: "May 1940",
cardTitle: "Dunkirk",
cardSubtitle:
"Men of the British Expeditionary Force (BEF) wade out to a destroyer during the evacuation from Dunkirk.",
cardDetailedText: ["paragraph1", "paragraph2"],
}
if you have a large text to display(via cardDetailedText) and want to split the text into paragraphs, you can pass an array of strings.
each array entry will be created as a paragraph inside the timeline card.
The timeline can be navigated via keyboard.
HORIZONTAL mode use your LEFT RIGHT arrow keys for navigation.VERTICAL or VERTICAL_ALTERNATING mode, the timeline can be navigated via the UP DOWN arrow keys.To disable keyboard navigation set disableNavOnKey to true.
<Chrono items={items} disableNavOnKey />
With the scrollable prop, you can enable scrolling on both VERTICAL and VERTICAL_ALTERNATING modes.
<Chrono items={items} scrollable />
The scrollbar is not shown by default. To enable the scrollbar, pass an object with prop scrollbar to scrollable prop.
<Chrono items={items} scrollable={{ scrollbar: true }} />
Both images and videos can be embedded in the timeline.
Just add the media attribute to the Timeline Item model and the component will take care of the rest.
{
title: "May 1940",
cardTitle: "Dunkirk",
media: {
name: "dunkirk beach",
source: {
url: "http://someurl/image.jpg"
},
type: "IMAGE"
}
}
Videos start playing automatically when active and will be automatically paused when not active.
Like images, videos are also automatically hidden when not in the visible viewport of the container.
{
title: "7 December 1941",
cardTitle: "Pearl Harbor",
media: {
source: {
url: "/pearl-harbor.mp4",
type: "mp4"
},
type: "VIDEO",
name: "Pearl Harbor"
}
}
To embed YouTube videos, use the right embed url.
{
title: "7 December 1941",
cardTitle: "Pearl Harbor",
media: {
source: {
url: "https://www.youtube.com/embed/f6cz9gtMTeI",
type: "mp4"
},
type: "VIDEO",
name: "Pearl Harbor"
}
}
The component also supports embedding custom content in the Timeline cards.
To insert custom content, just pass the blocked elements between the Chrono tags.
For e.g the below snippet will create 2 timeline items. Each div element is automatically converted into a timeline item and inserted into the timeline card.
The items collection is completely optional and custom rendering is supported on all 3 modes.
<Chrono mode="VERTICAL">
<div>
<p>Lorem Ipsum. Lorem Ipsum. Lorem Ipsum</p>
</div>
<div>
<img src="<url to a nice image" />
</div>
</Chrono>
The items collection will also work nicely with any custom content that is passed.
The following snippet sets the the title and cardTitle for the custom contents.
const items = [
{ title: 'Timeline title 1', cardTitle: 'Card Title 1' },
{ title: 'Timeline title 2', cardTitle: 'Card Title 2' },
];
<Chrono mode="VERTICAL" items={items}>
<div>
<p>Lorem Ipsum. Lorem Ipsum. Lorem Ipsum</p>
</div>
<div>
<img src="<url to a nice image" />
</div>
</Chrono>;
To use custom icons in the timeline, pass in the collection of images between the chrono tags wrapped in a container.
The icons are sequentially set (i.e) the first image you pass will be used as the icon for the first timeline item and so on.
Please make sure to pass in the image collection inside a container with a special className chrono-icons. This convention is mandatory as the component uses this class name to pick the images.
<Chrono items={items} mode="VERTICAL_ALTERNATING">
<div className="chrono-icons">
<img src="image1.svg" alt="image1" />
<img src="image2.svg" alt="image2" />
</div>
</Chrono>
custom icons also works if you are rendering custom content inside the cards.
<Chrono mode="VERTICAL" items={items}>
<div>
<p>Lorem Ipsum. Lorem Ipsum. Lorem Ipsum</p>
</div>
<div>
<img src="<url to a nice image" />
</div>
<div className="chrono-icons">
<img src="image1.svg" alt="image1" />
<img src="image2.svg" alt="image2" />
</div>
</Chrono>
Slideshow can be enabled by setting the slideShow prop to true. You can also set an optional slideItemDuration that sets the time delay between cards.
setting this prop enables the play button in the timeline control panel.
<Chrono items={items} slideShow slideItemDuration={4500} />
With enableOutline prop you can enable outline on the timelines and quickly jump to a specific timeline item.
The outlines are only supported on VERTICAL and VERTICAL_ALTERNATING modes.
<Chrono items={items} enableOutline />
The itemWidth prop can be used to set the width of each individual timeline sections. This setting is applicable only for the HORIZONTAL mode.
Customize colors with the theme prop.
<Chrono
items={items}
theme={{
primary: 'red',
secondary: 'blue',
cardBgColor: 'yellow',
cardForeColor: 'violet',
titleColor: 'black',
titleColorActive: 'red',
}}
/>
Use the fontSizes prop to customize the font sizes of the timeline card.
<Chrono
items={data}
mode="HORIZONTAL"
fontSizes={{
cardSubtitle: '0.85rem',
cardText: '0.8rem',
cardTitle: '1rem',
title: '1rem',
}}
></Chrono>
With the buttonTexts prop, you can change the button's alt text.
<Chrono
items={data}
mode="HORIZONTAL"
buttonTexts={{
first: 'Jump to First',
last: 'Jump to Last',
next: 'Next',
previous: 'Previous',
}}
></Chrono>
Defaults
| Property | Value |
|---|---|
first | 'Go to First' |
last | 'Go to Last' |
next | 'Next' |
play | 'Play Slideshow' |
previous | 'Previous' |
Deep dive into wide variety of examples hosted as a Storybook.
# install dependencies
pnpm install
# start dev
pnpm dev
# run css linting
pnpm lint:css
# eslint
pnpm eslint
# prettier
pnpm lint
# package lib
pnpm rollup
# run unit tests
pnpm test
# run cypress tests
pnpm cypress:test
git checkout -b new-feature)git commit -am 'Add feature')git push origin new-feature)Huge thanks to BrowserStack for the Open Source License!
Distributed under the MIT license. See LICENSE for more information.
Prabhu Murthy – @prabhumurthy2 – prabhu.m.murthy@gmail.com https://github.com/prabhuignoto
Thanks goes to these wonderful people (emoji key):
 Alois 📖 |  Koji 📖 |  Alexandre Girard 💻 |  Ryuya 📖 |  Taqi Abbas 💻 |  megasoft78 💻 |
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
A Modern Timeline component for React
The npm package react-chrono receives a total of 3,472 weekly downloads. As such, react-chrono popularity was classified as popular.
We found that react-chrono demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.