WuJi/gantt-task-react
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme update + release version ready

Browse Source
This commit is contained in:
unknown 2020-08-15 11:20:38 +03:00
parent 12393e4597
commit 5fe856c8f5
2 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -58,12 +58,12 @@ npm start
### GanttProps ### GanttProps
| Parameter Name | Type | Description | | Parameter Name | Type | Description |
| :------------------------------ | :-------- | :------------------------------------------------- | | :------------------------------ | :------------ | :------------------------------------------------- |
| tasks (Required) | Task | Tasks array. | | tasks\* | [Task](#Task) | Tasks array. |
| [EventOption](#EventOption) | interface | Specifies gantt events. | | [EventOption](#EventOption) | interface | Specifies gantt events. |
| [DisplayOption](#DisplayOption) | interface | Specifies view type and display timeline language. | | [DisplayOption](#DisplayOption) | interface | Specifies view type and display timeline language. |
| StylingOption | interface | Specifies chart and global tasks styles | | [StylingOption](#StylingOption) | interface | Specifies chart and global tasks styles |
### EventOption ### EventOption
@ -101,6 +101,30 @@ npm start
| arrowColor | string | Specifies the relationship arrow fill color. | | arrowColor | string | Specifies the relationship arrow fill color. |
| arrowIndent | number | Specifies the relationship arrow right indent. Sets in px | | arrowIndent | number | Specifies the relationship arrow right indent. Sets in px |
| todayColor | string | Specifies the current period column fill color. | | todayColor | string | Specifies the current period column fill color. |
| getTooltipContent | \* | Specifies the Tooltip for selected taskbar. | | getTooltipContent | \*\* | Specifies the Tooltip for selected taskbar. |
[\*`(task:Task, fontSize:string , fontFamily:string) => JSX.Element;`](https://github.com/MaTeMaTuK/gantt-task-react/blob/07dfeddd4d96ecc418619cad9cd9ba3c31bb82a8/src/components/Other/tooltip.tsx#L47) [\*\*`(task:Task, fontSize:string , fontFamily:string) => JSX.Element;`](https://github.com/MaTeMaTuK/gantt-task-react/blob/07dfeddd4d96ecc418619cad9cd9ba3c31bb82a8/src/components/Other/tooltip.tsx#L47)
### Task
| Parameter Name | Type | Description |
| :------------- | :----- | :---------------------------------------------------------------------------------------------- |
| id\* | string | Task id. |
| name\* | string | Task display name. |
| start\* | Date | Task start date. |
| end\* | Date | Task end date. |
| progress\* | number | Task progress. Sets in percent from 0 to 100. |
| styles | object | Specifies the taskbar styling settings locally. Object is passed with the following attributes: |
- backgroundColor: String. Specifies the taskbar background fill color locally.
- backgroundSelectedColor: String. Specifies the taskbar background fill color locally on select.
- progressColor: String. Specifies the taskbar progress fill color locally.
- progressSelectedColor: String. Specifies the taskbar progress fill color globally on select. |
| isDisabled | bool | Disables all action for current task. |
| fontSize | string | Specifies the taskbar font size locally. |
\*Required
## License
[MIT](https://oss.ninja/mit/jaredpalmer/)

2
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "gantt-task-react", "name": "gantt-task-react",
"version": "0.0.6", "version": "0.1.0",
"description": "Interactive Gantt Chart for React with TypeScript.", "description": "Interactive Gantt Chart for React with TypeScript.",
"author": "MaTeMaTuK <maksym.vikarii@gmail.com>", "author": "MaTeMaTuK <maksym.vikarii@gmail.com>",
"homepage": "https://github.com/MaTeMaTuK/gantt-task-react", "homepage": "https://github.com/MaTeMaTuK/gantt-task-react",