[![Build Status](https://dev.azure.com/prabhummurthy/react-chrono/_apis/build/status/prabhuignoto.react-chrono?branchName=master)](https://dev.azure.com/prabhummurthy/react-chrono/_build/latest?definitionId=7&branchName=master) [![DeepScan grade](https://deepscan.io/api/teams/10074/projects/13644/branches/234929/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=10074&pid=13644&bid=234929) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/f2e24a98defd4e4fa7f6f24d86b8dab5)](https://www.codacy.com/manual/prabhuignoto/react-chrono?utm_source=github.com&utm_medium=referral&utm_content=prabhuignoto/react-chrono&utm_campaign=Badge_Grade) [![react-chrono](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/8zb5a5&style=flat&logo=cypress)](https://dashboard.cypress.io/projects/8zb5a5/runs) [![Known Vulnerabilities](https://snyk.io/test/github/prabhuignoto/react-chrono/badge.svg)](https://snyk.io/test/github/prabhuignoto/react-chrono) [![Depfu](https://badges.depfu.com/badges/48a23a6a830309649b7e516467cd9a48/overview.svg)](https://depfu.com/github/prabhuignoto/react-chrono?project_id=15325) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/react-chrono) [![styled with Prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://prettier.io/) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![npm version](https://img.shields.io/npm/v/react-chrono.svg?style=flat)](https://www.npmjs.com/package/react-chrono) ![npm downloads](https://img.shields.io/npm/dm/react-chrono.svg?label=npm%20downloads&style=flat)

[![Coverage Status](https://coveralls.io/repos/github/prabhuignoto/react-chrono/badge.svg?branch=master)](https://coveralls.io/github/prabhuignoto/react-chrono?branch=master)

Table of Contents

``` ```jsx ``` ```jsx ``` ### Timeline item Model | name | description | type | | ------------------ | --------------------------------------------------------------------------------------------- | ------------------ | | `cardDetailedText` | detailed text displayed in the timeline card | String or String[] | | `cardSubtitle` | text displayed in the timeline card | String | | `cardTitle` | title that is displayed on the timeline card | String | | `date` | date to be used in the title. when used, this will override the title property | Date | | [`media`](#media) | media object to set image or video | Object | | `timelineContent` | render custom content instead of text.This prop has higher precedence over `cardDetailedText` | ReactNode | | `title` | title of the timeline item | String | | `url` | url to be used in the title | String | ```jsx { 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"], timelineContent:

Custom content

, } ``` 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. ### ⌨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. ```jsx ``` ### Scrollable With the scrollable prop, you can enable scrolling on both `VERTICAL` and `VERTICAL_ALTERNATING` modes. ```jsx ``` The scrollbar is not shown by default. To enable the scrollbar, pass an object with prop `scrollbar` to `scrollable` prop. ```jsx ``` ### 📺Media > Both images and videos can be embedded in the timeline. Just add the `media` attribute to the [Timeline Item model](#timeline-item-model) and the component will take care of the rest.

To embed a image

```jsx { 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. ```jsx { 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. ```jsx { title: "7 December 1941", cardTitle: "Pearl Harbor", media: { source: { url: "https://www.youtube.com/embed/f6cz9gtMTeI", type: "mp4" }, type: "VIDEO", name: "Pearl Harbor" } } ``` ![media](./readme-assets/media.png) ### Text overlay mode The `textOverlay` prop allows you to overlay text on top of a media element in a card.To enable the text overlay feature, simply add the text property to the items array in your Chrono timeline data. Here's an example: ```jsx import { Chrono } from 'react-chrono'; const items = [ { title: 'First item', media: { type: 'IMAGE', source: { url: 'https://example.com/image.jpg', }, }, text: 'This is the caption for the first item.', }, ]; function MyTimeline() { return ; } ``` The user can click on the `expand` button to expand the text and see more details. Here's what it looks like: ![timeline_card_text_overlay](readme-assets/text-overlay.png) > With the textOverlay prop, you can give your timeline a modern and sleek look, and provide additional context or information about each item. ### 🛠Rendering custom content The Timeline cards of the component can also support embedded custom content. To insert custom content, pass the blocked elements between the Chrono tags. For instance, the below code snippet will generate two timeline items, where each div element will be automatically converted into a timeline item and inserted into the timeline card. The items collection mentioned in the code is completely optional, and custom rendering is supported on all three modes. ```jsx

Lorem Ipsum. Lorem Ipsum. Lorem Ipsum

``` > Note that the items collection will also work well with any custom content that is passed. In the following code snippet, the title and cardTitle are set for the custom contents. ```jsx const items = [ { title: 'Timeline title 1', cardTitle: 'Card Title 1' }, { title: 'Timeline title 2', cardTitle: 'Card Title 2' }, ];

Lorem Ipsum. Lorem Ipsum. Lorem Ipsum

; ``` ### 🎭Custom icons for the Timeline To utilize personalized icons on the timeline, enclose a collection of images between the `chrono` tags, wrapped in a container. The icons are arranged sequentially; meaning, the first image that you pass in will be used as the icon for the first timeline item, and so on. It is important to note that the image collection must be passed in inside a container with the designated `chrono-icons` className. This is a required convention, as the component relies on this className to select the appropriate images. ```jsx

``` > custom icons also works if you are [rendering custom content](#rendering-custom-content) inside the cards. ```jsx

Lorem Ipsum. Lorem Ipsum. Lorem Ipsum

``` ### 🌿Nested Timelines Nested timelines in React-Chrono allow you to display timelines within timeline cards. This feature is data-driven, which means that if a timeline item has an `items` array, the component will automatically attempt to render the nested timeline inside the timeline card. To use nested timelines, simply provide an array of items within the `items` property of a timeline item. The component will then take care of rendering the nested timeline for you. You can also adjust the height of the nested timeline card using the `nestedCardHeight` prop. This allows you to control the size of the card to fit your specific use case. ```jsx const items = [ { title: 'Timeline title 1', cardTitle: 'Card Title 1', items: [ { cardTitle: 'nested card title 1' }, { cardTitle: 'nested card title 2' }, ], }, { title: 'Timeline title 2', cardTitle: 'Card Title 2' }, ]; ; ``` ### Slideshow Enabling the slideshow feature can be done by setting the `slideShow` prop to true. Additionally, an optional `slideItemDuration` prop can be set to determine the time delay between cards. Enabling this prop will cause the play button to appear in the timeline control panel. Use the `slideShowType` prop to set the type of slideshow animation. | Mode | Default Slideshow Type | | :------------------- | :--------------------- | | VERTICAL | `reveal` | | VERTICAL_ALTERNATING | `slide_from_sides` | | HORIZONTAL | `slide_in` | ```jsx ``` > The slideshow can be cancelled by clicking on the stop button in the control panel or by pressing the `ESC` key. ### 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. ### 🎥Media Settings Use media settings to align the media or change how a image is displayed in the card. | Name | Description | Type | Default | | :---- | :--------------------------------------------- | :----- | :------ | | align | aligns the media. can be left, right or center | string | center | | fit | fits the image. can be cover or contain | string | cover | ```jsx ``` ### Breakpoint Use the breakpoint feature to automatically switch the timeline to `VERTICAL` mode when there is not enough space for `VERTICAL_ALTERNATING` mode, such as on mobile devices. Set the auto switch to happen by enabling the `enableBreakPoint` prop and specifying the pixel limit with the `verticalBreakPoint` prop. ```jsx ``` ### 🎨Theme Customize colors with the `theme` prop. > Checkout the documentation for the complete list of available theme properties. ```jsx ``` ### Customize Font sizes Use the `fontSizes` prop to customize the font sizes of the timeline card. ```jsx ``` ### Customize alt text for buttons With the `buttonTexts` prop, you can change the button's alt text. ```jsx ``` Defaults | Property | Value | | :--------- | :--------------- | | `first` | 'Go to First' | | `last` | 'Go to Last' | | `next` | 'Next' | | `play` | 'Play Slideshow' | | `previous` | 'Previous' | ## Using custom class names You can use the classNames prop to employ your own class names. The subsequent example illustrates how you can use custom class names on different elements. ```jsx ``` ## 📦CodeSandbox Examples - [Horizontal Basic](https://codesandbox.io/s/keen-shannon-gtjwn?file=/src/App.js) - [Horizontal - Show all cards](https://codesandbox.io/s/show-all-cards-5vuf2x?file=/src/App.js) - [Vertical basic](https://codesandbox.io/s/react-chrono-vertical-basic-0rm1o?file=/src/App.js) - [Vertical Alternating](https://codesandbox.io/s/react-chrono-tree-text-1fcs3?file=/src/App.js) - [Vertical All Images](https://codesandbox.io/s/react-chrono-tree-vertical-images-b5zri?file=/src/App.js) - [Vertical Custom content](https://codesandbox.io/s/react-chrono-vertical-custom-qepnm?file=/src/App.js) - [Vertical Custom content with items collections](https://codesandbox.io/s/react-chrono-vertical-custom-2-uctcp?file=/src/App.js) - [Custom Icons](https://codesandbox.io/s/react-chrono-custom-icons-x9s2k?file=/src/App.js) ## Kitchen Sink - [Kitchen Sink](https://react-chrono-kitchen-sink.prabhumurthy.com/) ## 📚Storybook Deep dive into wide variety of examples hosted as a Storybook. - [Horizontal Collection](https://5f985eb478dcb00022cfd60e-oihbvdsnij.chromatic.com/?path=/story/example-horizontal--horizontal-timeline) - [Vertical Collection](https://5f985eb478dcb00022cfd60e-oihbvdsnij.chromatic.com/?path=/story/example-vertical--vertical-basic) ## 🔨Build Setup ```bash # install dependencies pnpm install # start dev pnpm dev # run css linting pnpm lint:css # eslint pnpm eslint # prettier pnpm lint # package lib pnpm rollup ``` ## 🧪Tests ```jsx # run unit tests pnpm test # run cypress tests pnpm cypress:test # run cypress tests in headless mode pnpm cypress:headless # run cypress tests in quiet mode pnpm cypress:quiet ``` ## 🤝Contributing 1. [Fork it](https://github.com/prabhuignoto/react-chrono/fork) 2. Create your feature branch (`git checkout -b new-feature`) 3. Commit your changes (`git commit -am 'Add feature'`) 4. Push to the branch (`git push origin new-feature`) 5. Create a new Pull Request ## 🧱Built with - [Typescript](https://www.typescriptlang.org/). - Styled with [emotion](https://emotion.sh/). ## Meta Huge thanks to [BrowserStack](https://www.browserstack.com/) for the Open Source License! Distributed under the MIT license. See `LICENSE` for more information. Prabhu Murthy – [@prabhumurthy2](https://twitter.com/prabhumurthy2) – [https://github.com/prabhuignoto](https://github.com/prabhuignoto)

## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_Alois 📖	_Koji 📖	_{Alexandre Girard} 💻	_Ryuya 📖	_{Taqi Abbas} 💻	_megasoft78 💻	_{Eric（书生）} 💻
_{Christophe Bernard} 💻

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

Features

Table of Contents

To embed a image

To embed a video