Skip to content

Commit 27fc1bd

Browse files
authored
Merge pull request namespace-ee#520 from tobiasbueschel/docs/spelling
docs: fix minor spelling mistakes + update links for react and react-native
2 parents 139a0f8 + 6b19330 commit 27fc1bd

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React Calendar Timeline
22

3-
A modern and responsive react timeline component.
3+
A modern and responsive React timeline component.
44

55
![calendar demo](https://raw.githubusercontent.com/namespace-ee/react-calendar-timeline/master/demo.gif)
66

@@ -16,7 +16,7 @@ yarn add react-calendar-timeline
1616
npm install --save react-calendar-timeline
1717
```
1818

19-
`react-calendar-timeline` has `react`, `react-dom`, [`moment`](http://momentjs.com/) and [`interactjs`](http://interactjs.io/docs/) as peer dependencies.
19+
`react-calendar-timeline` has [react](https://reactjs.org/), [react-dom](https://reactjs.org/docs/react-dom.html), [`moment`](http://momentjs.com/) and [`interactjs`](http://interactjs.io/docs/) as peer dependencies.
2020

2121
# Usage
2222

@@ -88,7 +88,7 @@ Expects either a vanilla JS array or an immutableJS array, consisting of objects
8888
}
8989
```
9090

91-
If you use right sidebar, you can pass optional `rightTitle` property here.
91+
If you use the right sidebar, you can pass optional `rightTitle` property here.
9292
If you want to overwrite the calculated height with a custom height, you can pass a `height` property as an int in pixels here. This can be very useful for categorized groups.
9393

9494
## items
@@ -118,15 +118,15 @@ Expects either a vanilla JS array or an immutableJS array, consisting of objects
118118
}
119119
```
120120

121-
The preferred (fastest) option is to give unix timestamps in milliseconds for `start_time` and `end_time`. Objects that convert to them (JavaScript Date or moment()) will also work, but will be a lot slower.
121+
The preferred (fastest) option is to give Unix timestamps in milliseconds for `start_time` and `end_time`. Objects that convert to them (JavaScript `Date` or `moment()`) will also work, but will be a lot slower.
122122

123123
## defaultTimeStart and defaultTimeEnd
124124

125125
Unless overridden by `visibleTimeStart` and `visibleTimeEnd`, specify where the calendar begins and where it ends. This parameter expects a Date or moment object.
126126

127127
## visibleTimeStart and visibleTimeEnd
128128

129-
The exact viewport of the calendar. When these are specified, scrolling in the calendar must be orchestrated by the `onTimeChange` function. This parameter expects a unix timestamp in milliseconds.
129+
The exact viewport of the calendar. When these are specified, scrolling in the calendar must be orchestrated by the `onTimeChange` function. This parameter expects a Unix timestamp in milliseconds.
130130

131131
**Note that you need to provide either `defaultTimeStart/End` or `visibleTimeStart/End` for the timeline to function**
132132

@@ -179,8 +179,7 @@ The minimum width, in pixels, of a timeline entry when it's possible to resize.
179179

180180
## stickyOffset
181181

182-
At what height from the top of the screen should we start "sticking" the header (i.e. position: sticky)? This is useful if for example you already have
183-
a sticky navbar and want to push the timeline header down further. Defaults `0`.
182+
At what height from the top of the screen should we start "sticking" the header (i.e. position: sticky)? This is useful if for example you already have a sticky navbar and want to push the timeline header down further. Defaults `0`.
184183

185184
## stickyHeader
186185

@@ -216,7 +215,7 @@ Largest time the calendar can zoom to in milliseconds. Default `5 * 365.24 * 864
216215

217216
## clickTolerance
218217

219-
How many pixels we can drag the background for it to be counted as a click on the background. Defualt: `3`
218+
How many pixels we can drag the background for it to be counted as a click on the background. Default `3`
220219

221220
## canMove
222221

@@ -435,9 +434,9 @@ Called when the bounds in the calendar's canvas change. Use it for example to lo
435434

436435
## itemRenderer
437436

438-
Render prop function used to render a customized item. The function provides multiple paramerters that can be used to render each item.
437+
Render prop function used to render a customized item. The function provides multiple parameters that can be used to render each item.
439438

440-
Paramters provided to the function has two types: context params which have the state of the item and timeline, and prop getters functions
439+
Parameters provided to the function has two types: context params which have the state of the item and timeline, and prop getters functions
441440

442441
#### Render props params
443442

@@ -490,7 +489,7 @@ Rather than applying props on the element yourself and to avoid your props being
490489
* `getItemProps` returns the props you should apply to the root item element. The returned props are:
491490

492491
* key: item id
493-
* ref: function to get item referance
492+
* ref: function to get item reference
494493
* className: classnames to be applied to the item
495494
* onMouseDown: event handler
496495
* onMouseUp: event handler
@@ -500,9 +499,9 @@ Rather than applying props on the element yourself and to avoid your props being
500499
* onContextMenu: event handler
501500
* style: inline object style
502501

503-
\*\* _the given styles will only override the styles that are not a requirement for postioning the item. Other styles like `color`, `radius` and others_
502+
\*\* _the given styles will only override the styles that are not a requirement for positioning the item. Other styles like `color`, `radius` and others_
504503

505-
These properties can be override using the prop argument with proprties:
504+
These properties can be override using the prop argument with properties:
506505

507506
* className: class names to be added
508507
* onMouseDown: event handler will be called after the component's event handler

0 commit comments

Comments
 (0)