gantt-task-react/README.md

65 lines
3.3 KiB
Markdown
Raw Normal View History

2020-07-22 23:33:13 +03:00
<h1 align="center">gantt-task-react</h1>
<h2 align="center">Interactive Gantt Chart for React with TypeScript.</h2>
<img src="https://user-images.githubusercontent.com/26743903/88215863-f35d5f00-cc64-11ea-81db-e829e6e9b5c8.png"/>
## How to use it
```javascript
let tasks: Task[] = [
{
start: new Date(2020, 1, 1),
end: new Date(2020, 1, 2),
name: 'Idea',
id: 'Task 0',
progress: 45,
isDisabled: true,
styles: { progressColor: '#ffbb54', progressSelectedColor: '#ff9e0d' },
},
...
];
<Gantt tasks={tasks} />
```
You may handle actions
```javascript
<Gantt
tasks={tasks}
viewMode={view}
onDateChange={onTaskChange}
onTaskDelete={onTaskDelete}
onProgressChange={onProgressChange}
onDoubleClick={onDblClick}
/>
```
## Gantt Configuration
2020-07-24 10:34:35 +03:00
### GanttProps
2020-07-24 10:26:44 +03:00
| Parameter Name | Type | Required | Description |
| ------------------------------- | :-------- | :------- | :------------------------------------------------------------------------------------ |
| tasks | Task | Yes | Tasks array. |
| [EventOption](#EventOption) | interface | No | Specifies the function to be executed on the bar`s on Delete button press event. |
| [DisplayOption](#DisplayOption) | interface | No | Specifies the function to be executed when drag bar`s event on timeline has finished. |
| StylingOption | interface | No | Specifies the function to be executed when drag bar`s progress event has finished |
2020-07-24 10:34:35 +03:00
### EventOption
2020-07-24 10:14:18 +03:00
| Parameter Name | Type | Required | Description |
| ---------------- | :-------------------------------- | :------- | :------------------------------------------------------------------------------------ |
| onDoubleClick | (task: Task) => any | No | Specifies the function to be executed on the bar`s onDoubleClick event. |
| onTaskDelete | (task: Task) => void/Promise<any> | No | Specifies the function to be executed on the bar`s on Delete button press event. |
| onDateChange | (task: Task) => void/Promise<any> | No | Specifies the function to be executed when drag bar`s event on timeline has finished. |
| onProgressChange | (task: Task) => void/Promise<any> | No | Specifies the function to be executed when drag bar`s progress event has finished |
| timeStep | number | No | A time step value for onDateChange. Specify in milliseconds |
2020-07-24 10:34:35 +03:00
### DisplayOption
2020-07-24 10:14:18 +03:00
2020-07-24 10:16:16 +03:00
| Parameter Name | Type | Required | Description |
| -------------- | :----- | :------- | :--------------------------------------------------------------------------------------------- |
| viewMode | enum | No | Specifies the time scale. Quarter Day, Half Day, Day, Week(ISO-8601, 1st day is Monday), Month |
| locale | string | No | Specifies the month name language. Able formats: ISO 639-2, Java Locale. |
2020-07-23 10:05:42 +03:00
Work in progress