Merge pull request #205 from melfore/203-docs-add-chapter-on-gantt-mo…

…de-usage [Docs] Added chapter on gantt mode usage
melfore · Feb 29, 2024 · e6141a6 · e6141a6
2 parents 8026e28 + 2490ab5
commit e6141a6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,18 @@ There can be from none to many tasks per each resource and tasks can be moved ac
 
 For each user interaction with tasks there is a dedicated hook function exposed by the component's props. This enables various use cases like displaying the details of a task inside a modal or calling an API each time the task is moved.
 
+### Gantt
+
+In order to create and display connection between tasks is neccesary setting dedicated props:
+RelatedTasks is a string array prop of TaskData that contains Ids of related Tasks.
+EnableLines is a global prop for the visualization of the connections.
+
+In this case OnTasksChange return also array of all tasks id that are inpacted by changed end of a the task at hand, and value of time in milliseconds of this variation.
+
+###By realtedTasks is mean these tasks that their start can depends of the end of the task in question.
+
+![gantt](./assets/gantt.png)
+
 ### Custom display
 
 Size of columns and rows can be adjusted using dedicated props:

diff --git a/assets/gantt.png b/assets/gantt.png