Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.4.0 #447

Merged
merged 25 commits into from
Jan 7, 2024
Merged

2.4.0 #447

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
6f9c350
fixes and updates
prabhuignoto Jan 4, 2024
d448830
enable parsing html in timeline items
prabhuignoto Jan 4, 2024
7db0a6f
update examples
prabhuignoto Jan 4, 2024
d5d94d2
disableInteraction to completely disable interaction
prabhuignoto Jan 4, 2024
01af1e8
added highlight card feature
prabhuignoto Jan 4, 2024
027d9c7
coverage files
prabhuignoto Jan 4, 2024
81dda76
coverage files
prabhuignoto Jan 4, 2024
c6e7371
revert e2e test cases
prabhuignoto Jan 4, 2024
49f165a
fix build issues
prabhuignoto Jan 4, 2024
5e9271d
updated readme with the new props
prabhuignoto Jan 4, 2024
c6018df
fix deepscan issues
prabhuignoto Jan 4, 2024
8408ee7
update unit test cases
prabhuignoto Jan 5, 2024
cd105ce
Restyle 2.4.0 (#448)
restyled-io[bot] Jan 5, 2024
853b13c
fix e2e tests
prabhuignoto Jan 5, 2024
ffa2592
Merge branch '2.4.0' of github.com:prabhuignoto/react-chrono into 2.4.0
prabhuignoto Jan 5, 2024
9c4d692
adding unit test cases for timeline card content
prabhuignoto Jan 5, 2024
1488f25
fix deep scan issues
prabhuignoto Jan 5, 2024
0418308
added unit test cases for
prabhuignoto Jan 6, 2024
b7bfa88
updated coverage report
prabhuignoto Jan 6, 2024
262848d
update tests
prabhuignoto Jan 6, 2024
3754a71
fix deep scan issues
prabhuignoto Jan 6, 2024
4034d24
fix size limit
prabhuignoto Jan 6, 2024
0378546
replace sanitize-html with xss
prabhuignoto Jan 6, 2024
8f70156
updated samples
prabhuignoto Jan 6, 2024
6dde7a8
rename props
prabhuignoto Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,16 +164,19 @@ Below are the available configuration options for the component:
| contentDetailsHeight | 150 | Controls the height of the details section if using cardDetailedText. Refer to [TimelineItem model](#timeline-item-model) for more info. |
| disableAutoScrollOnClick | false | Prevents auto-scrolling when a timeline card is clicked. |
| disableClickOnCircle | false | Disables the click action on circular points. |
| disableInteraction | false | Disables all the interactions with the Timeline. |
| disableNavOnKey | false | Turns off keyboard navigation. |
| disableTimelinePoint | false | Disables the timeline point in both `HORIZONTAL` and `VERTICAL` mode. |
| enableBreakPoint | true | Automatically switches to vertical mode when the vertical breakpoint is reached. |
| enableDarkToggle | false | Adds a toggle switch for dark mode. |
| enableOutline | false | Enables an outline menu in vertical and vertical alternating modes. |
| flipLayout | false | Reverses the layout (Right to Left). |
| focusActiveItemOnLoad | false | Automatically scrolls to and focuses on the `activeItemIndex` when loading. |
| fontSizes | | Allows customization of font sizes. |
| hideControls | false | Hides navigation controls. |
| itemWidth | 300 | Sets the width of the timeline section in horizontal mode. |
| highlightCardsOnHover | false | Highlights the card on hover |
| items | [] | A collection of Timeline Item Models. |
| itemWidth | 300 | Sets the width of the timeline section in horizontal mode. |
| lineWidth | 3px | Adjusts the width of the timeline track line. |
| mediaHeight | 200 | Sets the minimum height for media elements like images or videos in the card. |
| mediaSettings | | Configures settings specific to media layout. Refer to [mediaSettings](#media-settings) for more info. |
Expand All @@ -183,6 +186,7 @@ Below are the available configuration options for the component:
| onItemSelected | | Invokes a callback on item selection, passing relevant data. |
| onScrollEnd | | Detects the end of the timeline via `onScrollEnd`. |
| onThemeChange | | Invokes a callback when the theme changes, triggered via `enableDarkToggle`. |
| parseDetailsAsHTML | false | Parses the `cardDetailedText` as HTML. |
| scrollable | true | Makes the timeline scrollable in `VERTICAL` and `VERTICAL_ALTERNATING` modes. |
| showAllCardsHorizontal | false | Displays all cards in horizontal mode. By default, only the active card is shown. |
| slideItemDuration | 5000 | Sets the duration (in milliseconds) that a timeline card is active during a slideshow. |
Expand All @@ -195,7 +199,6 @@ Below are the available configuration options for the component:
| uniqueId | | Used with `noUniqueId` to set a custom unique id for the wrapper. |
| useReadMore | true | Enables or disables the "read more" button. Available if text content on the card is taller than the card itself. |
| verticalBreakPoint | 768px | Sets the pixel count below which the timeline will switch to `VERTICAL` mode. |
| disableTimelinePoint | false | Disables the timeline point in both `HORIZONTAL` and `VERTICAL` mode. |

### Mode

Expand Down
Loading
Loading