@kozlowskigrzegorz/react-gantt-localized

0.0.5 • Public • Published

React-gantt-localized

A beautiful react gantt component with some localized elements.
This is a fork of JSainsburyPLC/react-timelines

## API
### Gantt
| Property | value | default | Descriptions |
| :-----:| :----: | :----: | :---- |
| start | Date || The start date of the timeline |
| end | Date || The start date of the timeline |
| now | Date |new Date()| 'now' marker position |
| zoomIn | function | Zoom in control click handler |
| zoomOut | function | Zoom out control click handler |
| zoomMin | Number |1| Minimum zoom scale |
| zoomMax | Number |20| Maximum zoom scale |
| data | List |[]| The resources and tasks list |
| minWidth | Number |120| The min width of the timeline when resizing the window |
| sidebarWidth | Number |400| The width of the sidebar |
| onTaskClick | function || when click task element |
| enableSticky | Bool |true| Determine whether the header is sticky or not |
| scrollToNow | Bool |true| Determine whether to scroll to the now marker at first or not |
| showControls | Bool |false| Determine if zoom control is visible |
| monthsLabel | String | Localized text (months header) |
| weeksLabel | String | Localized text (weeks header) |
| daysLabel | String | Localized text (days header) |
| months | [String] | Array of comma separated strings naming months: e.g ['January','February'...] or ['Styczeń','Luty'] in polish |
| markerLabelFunction | function || provide function which return stringify date (shown when hovering marker at day) |
| shouldHighlightDay | function || provide function which return true if some day should be visualy highlighted|


### Resource
| Property | value | default | Descriptions |
| :-----:| :----: | :----: | :---- |
| id | String/Number || The id of the Resource |
| title | String/Element || The title of the Resource |
| tasks | List || All the tasks of the Resource |
| subTasks | List || All the sub tasks  |
| isOpen | Bool |false| Determine whether the project is folded  not |

### Task
| Property | value | default | Descriptions |
| :-----:| :----: | :----: | :---- |
| id | String/Number || The id of the Task |
| title | String/Element || The title of the Task |
| start | Date || The start date of the Task |
| end | Date || The start date of the Task |
| style | Object || CSS of task background style |
| tooltip | React.Component || If provided, custom tooltip will be rendered |


## Development

```sh
yarn install
yarn watch
yarn build

Package Sidebar

Install

npm i @kozlowskigrzegorz/react-gantt-localized

Weekly Downloads

6

Version

0.0.5

License

MIT

Unpacked Size

127 kB

Total Files

69

Last publish

Collaborators

  • kozlowskigrzegorz