Table of Contents#
Timeline Props#
| Prop | Type | Default | Description |
|---|---|---|---|
| children | React.ReactNode | - | Timeline content elements to be displayed. |
| position | left right mixed | 'left' | Position of the timeline items. `mixed` alternates positions. |
| className | string | - | Additional CSS class for the timeline container. |
| lineClassName | string | - | Additional CSS class for the timeline line element. |
| lineStyle | solid dashed | 'solid' | The style of the connecting line between timeline items. |
| ...rest | React.HTMLAttributes<HTMLDivElement> | - | Additional props passed to the timeline container element. |
TimelineItem Props#
| Prop | Type | Default | Description |
|---|---|---|---|
| children | React.ReactNode | - | Content for the timeline item. |
| position | left right | 'left' | The side where the timeline item is displayed. |
| isMixed | boolean | false | Indicates if the timeline item is part of a mixed-position timeline. |
| icon | React.ReactNode | - | Optional icon to display in the timeline dot. |
| className | string | '' | Additional CSS class for the timeline item element. |
| containerClassName | string | '' | Additional CSS class for the item’s container. |
| dotClassName | string | '' | Additional CSS class for the timeline dot element. |
| ...rest | React.HTMLAttributes<HTMLDivElement> | - | Additional props passed to the timeline item container. |