Skip to content

Commit 88cbd19

Browse files
committed
chore: small readme fixes
1 parent 95d6821 commit 88cbd19

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -68,16 +68,16 @@ The available properties of the `Timeline` component:
6868

6969
An array of the following properties:
7070

71-
| Property | Type | Description |
72-
| :--------------- | :------------------ | :------------------------------------------------------------------------------- |
73-
| `key` | `Key` | Unique key for each item |
74-
| `title?` | `string` | Optional title paragraph displayed bold |
75-
| `date` | `Date \| string` | Date either being formatted according to provided format or passed as a `string` |
76-
| `children?` | `ReactNode` | Pass custom content as `children` to the component |
77-
| `dateFormat?` | `string` | Overwriting `dateFormat` property of parent `Timeline` |
78-
| `dateLocale?` | `string` | Overwriting `dateLocale` property of parent `Timeline` |
79-
| `customMarker?` | `ReactElement` | Overwriting `customMarker` property of parent `Timeline` |
80-
| `customPointer?` | `ReactElement` | Overwriting `customPointer` property of parent `Timeline` |
71+
| Property | Type | Description |
72+
| :--------------- | :--------------- | :------------------------------------------------------------------------------- |
73+
| `key` | `Key` | Unique key for each item |
74+
| `title?` | `string` | Optional title paragraph displayed bold |
75+
| `date` | `Date \| string` | Date either being formatted according to provided format or passed as a `string` |
76+
| `children?` | `ReactNode` | Pass custom content as `children` to the component |
77+
| `dateFormat?` | `string` | Overwriting `dateFormat` property of parent `Timeline` |
78+
| `dateLocale?` | `string` | Overwriting `dateLocale` property of parent `Timeline` |
79+
| `customMarker?` | `ReactElement` | Overwriting `customMarker` property of parent `Timeline` |
80+
| `customPointer?` | `ReactElement` | Overwriting `customPointer` property of parent `Timeline` |
8181

8282
### StyleConfig
8383

@@ -131,4 +131,4 @@ The style can either be passed as a javascript object...
131131

132132
## Demo
133133

134-
View a full demo of component as storybook: [Storybook](https://openscript-ch.github.io/react-alternating-timeline/) 📗
134+
View a full demo of component as storybook: [Storybook](https://openscript-ch.github.io/react-alternating-timeline/) 📚

0 commit comments

Comments
 (0)