diff --git a/README.md b/README.md index d565fbc7f..a53edf39f 100644 --- a/README.md +++ b/README.md @@ -580,7 +580,7 @@ Data to be passed to `rowRenderer`'s `rowData` param. Changing this prop will c # Helpers -Helpers are methods provided by `HelperContext`. These helpers power most of the rendered UI in the timeline like: Headers, Markers, Items and row renderers. +Helpers are methods provided by `HelperContext`. These helpers power most of the rendered UI in the timeline like: Headers, Markers, Items and row renderers. ## Methods @@ -598,7 +598,7 @@ Given `left` position in `px`, the method will return the corresponding date in Given a item id, It will return back the left and top of the item relative to row it is in. This is useful to know the where an item is relative to other items in the same row. -### `getItemAbsoluteDimensions(itemId: string|number): dimensions`. +### `getItemAbsoluteDimensions(itemId: string|number): dimensions`. Given a item id, It will return back the left and top of the item relative to the calendar container. This is useful to know the position of items in different rows relative to each other. @@ -858,7 +858,7 @@ Custom renderer for this marker. Ensure that you always pass `styles` to the roo ``` -Helpers are a group of +Helpers are a group of # Timeline Headers @@ -1448,7 +1448,7 @@ type rowRenderer = (args: Params) => React.Node ### getLayerRootProps -These functions are used to apply props to the layer that you want to render. This gives you maximum flexibility to render what, when, and wherever you like. +These functions are used to apply props to the layer that you want to render. This gives you maximum flexibility to render what, when, and wherever you like. ### rowData @@ -1460,7 +1460,7 @@ current group being rendered in the row. ### itemsWithInteractions -items to be rendered in the row. These items respect visibility and interaction. This means that the items you will get back are only the items in the visible + buffer zone and if dragging/resizing is happening you will get the items the start/end time with the interaction. +items to be rendered in the row. These items respect visibility and interaction. This means that the items you will get back are only the items in the visible + buffer zone and if dragging/resizing is happening you will get the items the start/end time with the interaction. ## Components @@ -1640,7 +1640,7 @@ $ yarn start Check http://0.0.0.0:8888/ in your browser and have fun! -Please run `npm run lint` before you send a pull request. `npm run jest` runs the tests. +Please run `npm run lint` before you send a pull request. `npm run test` runs the tests.