@danyilf/gantt-task-react v0.4.21

gantt-task-react

Interactive Gantt Chart for React with TypeScript.

Live Demo

Install

npm install gantt-task-react

How to use it

import { Gantt, Task, EventOption, StylingOption, ViewMode, DisplayOption } from 'gantt-task-react';
import "gantt-task-react/dist/index.css";

let tasks: Task[] = [
    {
      start: new Date(2020, 1, 1),
      end: new Date(2020, 1, 2),
      name: 'Idea',
      id: 'Task 0',
      type:'task',
      progress: 45,
      isDisabled: true,
      styles: { progressColor: '#ffbb54', progressSelectedColor: '#ff9e0d' },
    },
    ...
];

// Basic usage
<Gantt tasks={tasks} />

// With styling options
<Gantt
  tasks={tasks}
  viewMode={ViewMode.Day}
  listCellWidth="155px"
  hideTimeColumns={false} // Set to true to hide "From" and "To" columns
/>

// With today line enabled (instead of cell highlighting)
<Gantt
  tasks={tasks}
  todayLineEnabled={true} 
  todayLineColor="#0066FF"
/>

// With event handlers
<Gantt
  tasks={tasks}
  viewMode={view}
  onDateChange={onTaskChange}
  onTaskDelete={onTaskDelete}
  onProgressChange={onProgressChange}
  onDoubleClick={onDblClick}
  onClick={onClick}
/>

How to run example

cd ./example
npm install
npm start

Gantt Configuration

GanttProps

EventOption

* Chart undoes operation if method return false or error. Parameter children returns one level deep records.

DisplayOption

StylingOption

• TooltipContent: React.FC<{ task: Task; fontSize: string; fontFamily: string; }>;
• TaskListHeader: React.FC<{ headerHeight: number; rowWidth: string; fontFamily: string; fontSize: string;}>;
• TaskListTable: React.FC<{ rowHeight: number; rowWidth: string; fontFamily: string; fontSize: string; locale: string; tasks: Task[]; selectedTaskId: string; setSelectedTask: (taskId: string) => void; }>;

Task

*Required

Example: Using the icon property

You can use the icon property to display icons next to task names. This property accepts any React.ReactNode.

import React from 'react';
import { Task } from 'gantt-task-react';
import { Bug, Settings } from 'lucide-react'; // Example using lucide-react

const tasks: Task[] = [
  {
    id: 'Task 1',
    name: 'Setup Project',
    type: 'task',
    start: new Date(2024, 5, 1),
    end: new Date(2024, 5, 2),
    progress: 100,
    icon: <Settings size={16} /> // Simple icon
  },
  {
    id: 'Task 2',
    name: 'Fix Critical Bug',
    type: 'task',
    start: new Date(2024, 5, 3),
    end: new Date(2024, 5, 4),
    progress: 0,
    // Icon with custom styling (e.g., background color)
    icon: (
      <span
        style={{
          backgroundColor: '#E53E3E', // Red background
          color: 'white',
          padding: '2px 4px',
          borderRadius: '3px',
          display: 'inline-flex',
          alignItems: 'center',
          justifyContent: 'center',
        }}
      >
        <Bug size={12} />
      </span>
    ),
  },
];

License

MIT

Using refs to control the Gantt chart

You can use refs to access methods that control the Gantt chart programmatically:

import React, { useRef } from 'react';
import { Gantt, Task, GanttRef } from 'gantt-task-react';

const App = () => {
  const ganttRef = useRef<GanttRef>(null);
  
  const handleJumpToNow = () => {
    ganttRef.current?.jumpToNow();
  };
  
  const handleExpandAll = () => {
    ganttRef.current?.expandAll();
  };
  
  const handleCollapseAll = () => {
    ganttRef.current?.collapseAll();
  };
  
  return (
    <div>
      <button onClick={handleJumpToNow}>Jump to Current Time</button>
      <button onClick={handleExpandAll}>Expand All</button>
      <button onClick={handleCollapseAll}>Collapse All</button>
      <Gantt 
        ref={ganttRef}
        tasks={tasks} 
        todayLineEnabled={true}
        todayLineColor="#0066FF"
      />
    </div>
  );
};

GanttRef Methods