From 057bb08c1bcadbfb440f1c71364227fb5827e5c6 Mon Sep 17 00:00:00 2001 From: Prabhu Date: Tue, 27 Oct 2020 22:41:44 +0530 Subject: [PATCH 1/2] 1.4.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 88bfb381..7a4271f2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-chrono", - "version": "1.3.3", + "version": "1.4.0", "license": "MIT", "description": "A Modern Timeline component for React", "keywords": [ From 6d2d3795428f41b4e50d0d31d8ad2377f5336c4f Mon Sep 17 00:00:00 2001 From: Prabhu Date: Tue, 27 Oct 2020 22:54:18 +0530 Subject: [PATCH 2/2] update readme --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8b010dd9..86fcc875 100644 --- a/README.md +++ b/README.md @@ -23,13 +23,11 @@

Features

-- 🚥 Render timelines in three different modes ([Horizontal](#-getting-started), [Vertical](#vertical-mode), [Tree](#tree)). -- 🌲  Use the [Tree](#tree) mode to layout the timeline cards vertically in a tree like fashion. +- 🚥 Render timelines in three different modes ([Horizontal](#-getting-started), [Vertical](#vertical-mode), [Vertical-Alternating](#vertical-alternating)). - 📺  Auto play the timeline with the [slideshow](#slideshow-mode) mode. - 🖼️  [Display Images & Videos](#media) in the timeline with ease. - ⌨  [Keyboard accessible](#keyboard-navigation). - ⚡  Data driven API. -- 🔧  Optimized to render images & videos efficiently on (Tree & Vertical mode). - 🎨  [Customize](#theme) colors with ease. - 💪  Built with [Typescript](https://www.typescriptlang.org/). - 🎨  Styled with [emotion](https://emotion.sh). @@ -39,7 +37,7 @@ - [⚡ Installation](#-installation) - [Getting Started](#getting-started) - [Vertical Mode](#vertical-mode) - - [Tree](#tree) + - [Vertical Alternating](#vertical-alternating) - [Slideshow](#slideshow) - [Props](#props) - [Mode](#mode) @@ -110,9 +108,9 @@ To render the timeline vertically use the `VERTICAL` mode ![vertical-basic](./readme-assets/vertical-basic.png) -### Tree +### Vertical Alternating -In `Tree` mode the timeline is rendered vertically with cards alternating between left and right side. +In `VERTICAL_ALTERNATING` mode the timeline is rendered vertically with cards alternating between left and right side. ```sh
@@ -127,7 +125,7 @@ In `Tree` mode the timeline is rendered vertically with cards alternating betwee ### Slideshow -Play the timeline automatically with the `slideShow` mode. +Play the timeline automatically with the `slideShow` mode. This prop enables the play button on the ui controls. ```sh
@@ -158,7 +156,7 @@ Play the timeline automatically with the `slideShow` mode. ### Mode -`react-chrono` supports three modes `HORIZONTAL`, `VERTICAL` and `TREE`. No additional setting is required. +`react-chrono` supports three modes `HORIZONTAL`, `VERTICAL` and `VERTICAL_ALTERNATING`. No additional setting is required. ```sh @@ -203,7 +201,7 @@ Play the timeline automatically with the `slideShow` mode. The timeline can be navigated via keyboard. - For `HORIZONTAL` mode use your LEFT RIGHT arrow keys for navigation. -- For `VERTICAL` or `TREE` mode, the timeline can be navigated via the UP DOWN arrow keys. +- 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. @@ -280,8 +278,8 @@ Customize colors with `theme` prop. ## 📦 CodeSandbox Examples - [Horizontal Basic](https://codesandbox.io/s/condescending-swirles-xodxo?file=/src/App.js) -- [Tree](https://codesandbox.io/s/react-chrono-tree-text-xtksq) -- [Tree with Images](https://codesandbox.io/s/react-chrono-tree-image-uh2nz) +- [Vertical Alternating](https://codesandbox.io/s/react-chrono-tree-text-xtksq) +- [Vertical Alternating with Images](https://codesandbox.io/s/react-chrono-tree-image-uh2nz) - [Vertical basic](https://codesandbox.io/s/react-chrono-tree-text-slide-zytpi?file=/src/App.js) - [Vertical mode with Mixed content](https://codesandbox.io/s/react-chrono-tree-horizontal-wdqk3) @@ -324,6 +322,7 @@ yarn run rollup ## 🎯 What's coming next - Support for Mobile devices & Tablets (responsive). +- Accessibility support. ## Meta