Skip to content

Commit 162899e

Browse files
committed
fix: character escaping in readme
1 parent a35f6b6 commit 162899e

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
@@ -49,17 +49,17 @@ const items: TimelineItemsProps = [
4949

5050
The available properties of the `Timeline` component:
5151

52-
| Property | Type | Description | Default |
53-
| :--------------- | :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :-------------- |
54-
| `items` | [`TimelineItemsProps`](#timelineitemsprops) | Array of timeline items | |
55-
| `positioning?` | `'alternating' \| 'left' \| 'right'` | How the items should be positioned relative to the timeline | `'alternating'` |
56-
| `minMarkerGap?` | `number` | The minimum gap markers will have between each other | 50 (`px`) |
57-
| `dateLocal?` | `Local` | Date locale | |
58-
| `dateFormat?` | `string` | Specific date format according to date-fns [specification](https://date-fns.org/v2.29.3/docs/format). Ignored when passing a `string` as date | `'P'` |
59-
| `customMarker?` | `ReactElement` | Custom maker element replacing the default | |
60-
| `customPointer?` | `ReactElement` | Custom pointer element replacing the default | |
61-
| `styleConfig?` | [`StyleConfig`](#styleconfig) | Style config object for customizing timeline by setting css custom properties | |
62-
| `className?` | `string` | Additional class name | |
52+
| Property | Type | Description | Default |
53+
| :--------------- | :------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :-------- | ----------------------------------------------------------- | --------------- |
54+
| `items` | [`TimelineItemsProps`](#timelineitemsprops) | Array of timeline items | |
55+
| `positioning?` | `'alternating' | 'left' | 'right'` | How the items should be positioned relative to the timeline | `'alternating'` |
56+
| `minMarkerGap?` | `number` | The minimum gap markers will have between each other | 50 (`px`) |
57+
| `dateLocal?` | `Local` | Date locale | |
58+
| `dateFormat?` | `string` | Specific date format according to date-fns [specification](https://date-fns.org/v2.29.3/docs/format). Ignored when passing a `string` as date | `'P'` |
59+
| `customMarker?` | `ReactElement` | Custom maker element replacing the default | |
60+
| `customPointer?` | `ReactElement` | Custom pointer element replacing the default | |
61+
| `styleConfig?` | [`StyleConfig`](#styleconfig) | Style config object for customizing timeline by setting css custom properties | |
62+
| `className?` | `string` | Additional class name | |
6363

6464
### TimelineItemsProps
6565

0 commit comments

Comments
 (0)