Documentation
Every guide and reference page for @jaeungkim/gantt-chart, in reading order.
Read in order if you are new. Jump straight to a guide if you are not.
Guides
| Page | What it covers |
|---|---|
| Introduction | What the library is, and what it deliberately leaves to you |
| Concepts and vocabulary | Every term the rest of the docs use, defined once |
| Quick start | Install to a working, editable chart |
| Task data | The Task shape, date handling, and how the tasks prop is compared |
| Task list and hierarchy | The left pane, columns, and the parentId tree |
| Grouping and swimlanes | groupBy, group header rows, and lanes |
| The timeline | Scales, range, zoom, markers, and non-working days |
| Editing tasks | Move, resize, progress, permissions, touch, and drawing a task |
| Dependencies | The four link types, lag, and drawing arrows |
| Scheduling | Auto-scheduling, the working calendar, critical path, baselines |
| Reordering rows | Dragging rows to reorder and re-parent |
| Events and cancellable changes | Callbacks, and vetoing an edit before it commits |
| Custom rendering | Per-task colors and the four render props |
| Imperative API | The ref handle: scrolling, zoom, undo/redo, PNG export |
| Keyboard and screen readers | The key map, the ARIA tree, and the gaps |
| Locale and date formats | locale, per-scale overrides, week start |
| Theming | The theme prop and the CSS custom properties |
| Headless core | Scheduling without React or a DOM |
Reference
| Page | Symbols |
|---|---|
| GanttProps | every prop the component accepts |
| Task and task types | Task, TaskDependency, DependencyType, TaskType, TaskTransformed |
| GanttInteractionConfig | GanttInteractionConfig and the capability order |
| GanttColumn | GanttColumn |
| Grouping types | GanttGroupBy, GanttRow, GanttRowGroup |
| Markers and range bands | GanttMarker, GanttRangeBand, GanttDateRange |
| Render prop types | GanttBarRenderer, GanttTooltipRenderer, GanttHeaderCellRenderer |
| Change and draft types | GanttTaskChange, GanttReorderChange, GanttDependencyChange, GanttTaskDraft |
| GanttHandle | GanttHandle, GanttScrollApi, GanttScrollOptions, GanttZoomAnchor |
| GanttHistoryApi | GanttHistoryApi |
| PNG export | GanttExportApi, GanttExportOptions, GanttExportRange |
| Scale and theme types | GanttScaleKey, GanttScaleFormat, GanttFormatOverrides, GanttTheme |
| scheduleTasks | scheduleTasks, SchedulingPolicy, ScheduleOptions, ScheduleResult |
| Task graph helpers | buildTaskGraph, canLink, findPath, linkKey, TaskGraph |
| Tree helpers | buildTaskTree, collectSubtreeIds, rollUpTasks, TaskTree |
| Critical path | computeCriticalPath, forwardPass, backwardPass |
| Working calendar | createWorkingCalendar, CALENDAR_DAYS, WorkingCalendar |