Features
Table of Contents
โก Installation
yarn install react-chrono
Getting Started
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",
cardSubtitle:"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>
)
}
Vertical Mode
To render the timeline vertically use the VERTICAL
mode
<div style={{ width: "500px", height: "950px" }}>
<chrono
items={items}
mode="VERTICAL"
/>
</div>
Vertical Alternating
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>
Slideshow
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>
Props
name | description | default |
---|
mode | sets the mode of the component. can be HORIZONTAL , VERTICAL or VERTICAL_ALTERNATING | HORIZONTAL |
items | collection of Timeline Item Model. | [] |
disableNavOnKey | disables the keyboard navigation. | false |
slideShow | enables the slideshow control. | false |
slideItemDuration | duration (in ms), the timeline card is active during a slideshow . | 5000 |
itemWidth | width of the timeline section in HORIZONTAL mode. | 300 |
hideControls | hides the navigation controls. | 300 |
cardHeight | sets the minimum height of the timeline card. | 250 |
scrollable | makes the timeline scrollable (applicable for VERTICAL & VERTICAL_ALTERNATING ). | true |
cardPositionHorizontal | positions the card in HORIZONTAL mode. can be either TOP or BOTTOM | |
theme | prop to customize the colors. | |
Mode
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" />
Timeline item Model
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 |
media | media object to set image or video. | Object |
{
title: "May 1940",
cardTitle: "Dunkirk",
media: {
name: "dunkirk beach",
source: {
url: "http://someurl/image.jpg"
},
type: "IMAGE"
},
cardSubtitle:
"Men of the British Expeditionary Force (BEF) wade out to a destroyer during the evacuation from Dunkirk."
}
Keyboard Navigation
The timeline can be navigated via keyboard.
- For
HORIZONTAL
mode use your LEFT RIGHT arrow keys for navigation. - For
VERTICAL
or VERTICAL_ALTERNATING
mode, the timeline can be navigated via the UP DOWN arrow keys. - To easily jump to the first item or the last item in the timeline, use HOME or END keys.
To disable keyboard navigation set disableNavOnKey
to true.
<chrono items={items} disableNavOnKey />
Scrollable
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}} />
Media
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.
To embed a image
{
title: "May 1940",
cardTitle: "Dunkirk",
media: {
name: "dunkirk beach",
source: {
url: "http://someurl/image.jpg"
},
type: "IMAGE"
}
}
To embed a video
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"
}
}
Slideshow mode
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} />
Item Width
The itemWidth
prop can be used to set the width of each individual timeline sections. This setting is applicable only for the HORIZONTAL
mode.
Theme
Customize colors with theme
prop.
<chrono items={items} theme={{primary: "red", secondary: "blue" }} />
๐ฆ CodeSandbox Examples
๐จ Build Setup
yarn install
yarn run start
yarn run lint:css
yarn run eslint
yarn run lint
yarn run rollup
๐งช Tests
yarn run test
yarn run cypress:test
๐ค Contributing
- Fork it
- Create your feature branch (
git checkout -b new-feature
) - Commit your changes (
git commit -am 'Add feature'
) - Push to the branch (
git push origin new-feature
) - Create a new Pull Request
๐งฑ Built with
๐ฏ What's coming next
- Support for Mobile devices & Tablets (responsive).
- Rendering custom content in timeline cards.
Meta
Prabhu Murthy โ @prabhumurthy2 โ prabhu.m.murthy@gmail.com
Distributed under the MIT license. See LICENSE
for more information.
https://github.com/prabhuignoto