gantt-task-react-v 1.0.0

package/dist/types/common-types.d.ts

@@ -0,0 +1,114 @@
+import { CSSProperties } from "react";
+import type { Locale as DateLocale } from "date-fns";
+export type TaskBarMoveAction = "progress" | "end" | "start" | "move";
+export type RelationMoveTarget = "startOfTask" | "endOfTask";
+export declare enum ViewMode {
+    Hour = "Hour",
+    QuarterDay = "Quarter Day",
+    HalfDay = "Half Day",
+    Day = "Day",
+    /** ISO-8601 week */
+    Week = "Week",
+    Month = "Month",
+    Year = "Year"
+}
+export type TaskType = "task" | "milestone" | "project";
+export type TaskId = string;
+export interface Dependency {
+    sourceId: string;
+    sourceTarget: RelationMoveTarget;
+    ownTarget: RelationMoveTarget;
+}
+/**
+ * date-fns formats
+ */
+export interface DateFormats {
+    dateColumnFormat: string;
+    dayBottomHeaderFormat: string;
+    dayTopHeaderFormat: string;
+    hourBottomHeaderFormat: string;
+    monthBottomHeaderFormat: string;
+    monthTopHeaderFormat: string;
+    weekBottomHeader: (date: Date, weekNumber: number, locale?: DateLocale) => string;
+}
+export interface Task {
+    id: TaskId;
+    type: TaskType;
+    name: string;
+    start: Date;
+    end: Date;
+    /**
+     * From 0 to 100
+     */
+    progress: number;
+    assignees?: string[];
+    style?: CSSProperties;
+    isDisabled?: boolean;
+    /**
+     * Project or task
+     */
+    parent?: string;
+    dependencies?: Dependency[];
+    comparisonDates?: {
+        start: Date;
+        end: Date | null;
+    };
+    hideChildren?: boolean;
+    displayOrder?: number;
+    comparisonLevel?: number;
+    payload?: Record<string, string>;
+}
+export interface EmptyTask {
+    id: string;
+    type: "empty";
+    name: string;
+    parent?: string;
+    comparisonLevel?: number;
+    displayOrder?: number;
+    isDisabled?: boolean;
+}
+export type RenderTask = Task | EmptyTask;
+export type ChildByLevelMap = Map<number, Map<string, RenderTask[]>>;
+export type RootMapByLevel = Map<number, RenderTask[]>;
+export interface DateSetup {
+    dateFormats: DateFormats;
+    dateLocale?: DateLocale;
+    isUnknownDates: boolean;
+    preStepsCount: number;
+    viewMode: ViewMode;
+}
+export interface Distances {
+    actionColumnWidth: number;
+    arrowIndent: number;
+    barCornerRadius: number;
+    /**
+     * How many of row width can be taken by task.
+     * From 0 to 100
+     */
+    barFill: number;
+    columnWidth: number;
+    barComparisonTaskHeight: number;
+    barComparisonTaskBorderHeight: number;
+    barComparisonTaskYOffset: number;
+    contextMenuIconWidth: number;
+    contextMenuOptionHeight: number;
+    contextMenuSidePadding: number;
+    dateCellWidth: number;
+    dependenciesCellWidth: number;
+    expandIconWidth: number;
+    handleWidth: number;
+    headerHeight: number;
+    ganttHeight?: number;
+    minimumRowDisplayed: number;
+    nestedTaskNameOffset: number;
+    relationCircleOffset: number;
+    relationCircleRadius: number;
+    rowHeight: number;
+    tableWidth?: number;
+    titleCellWidth: number;
+    viewModeYearOffsetYears?: number;
+    viewModeMonthOffsetMonths?: number;
+    viewModeWeekOffsetWeeks?: number;
+    viewModeDayOffsetDays?: number;
+    viewModeHourOffsetHours?: number;
+}

package/dist/types/gantt-task-actions.d.ts

@@ -0,0 +1,9 @@
+import { RelationMoveTarget, Task } from "./common-types";
+export type GanttRelationEvent = {
+    target: RelationMoveTarget;
+    task: Task;
+    startX: number;
+    startY: number;
+    endX: number;
+    endY: number;
+};

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./common-types";
+export * from "./theme-types";
+export * from "./theme-locale";
+export * from "./public-types";
+export * from "./internal-types";
+export * from "./gantt-task-actions";

package/dist/types/internal-types.d.ts

@@ -0,0 +1,222 @@
+import { ChildByLevelMap, DateSetup, Distances, RelationMoveTarget, Task, TaskBarMoveAction, RenderTask } from "./common-types";
+import { CSSProperties, MouseEvent, RefObject } from "react";
+import { OptimizedListParams } from "../helpers/use-optimized-list";
+import { AllowReorderTask, Column, GanttRenderIconsProps, InsertTaskPosition } from "./public-types";
+export interface ExpandedDependent {
+    containerHeight: number;
+    containerY: number;
+    innerFromY: number;
+    innerToY: number;
+    marginBetweenTasks: number | null;
+    dependent: Task;
+    dependentTarget: RelationMoveTarget;
+    ownTarget: RelationMoveTarget;
+}
+export type CriticalPaths = Map<number, CriticalPath>;
+export type ChangeInProgress = {
+    action: TaskBarMoveAction;
+    additionalLeftSpace: number;
+    additionalRightSpace: number;
+    changedTask: Task;
+    coordinates: TaskCoordinates;
+    coordinatesDiff: number;
+    initialCoordinates: TaskCoordinates;
+    lastClientX: number;
+    startX: number;
+    task: Task;
+    taskRootNode: Element;
+    tsDiff: number;
+};
+export type TaskComparisonDatesCoordinates = {
+    /**
+     * Top border of the comparison task relative to the root svg
+     */
+    y: number;
+    /**
+     * Left border of the comparison task relative to the root svg
+     */
+    x: number;
+    /**
+     * Width of the comparison task
+     */
+    width: number;
+    /**
+     * Height of the comparison task
+     */
+    height: number;
+};
+export type TaskCoordinates = {
+    /**
+     * Width of inner svg wrapper
+     */
+    containerWidth: number;
+    /**
+     * Left border of inner svg wrapper relative to the root svg
+     */
+    containerX: number;
+    /**
+     * Left border relative to the wrapper svg
+     */
+    innerX1: number;
+    /**
+     * Right border relative to the wrapper svg
+     */
+    innerX2: number;
+    /**
+     * Top border of inner svg wrapper relative to the root svg
+     */
+    levelY: number;
+    /**
+     * Width of the progress bar
+     */
+    progressWidth: number;
+    /**
+     * Left border of the progress bar relative to the root svg
+     */
+    progressX: number;
+    /**
+     * Width of the task
+     */
+    width: number;
+    /**
+     * Left border of the task relative to the root svg
+     */
+    x1: number;
+    /**
+     * Right border of the task relative to the root svg
+     */
+    x2: number;
+    /**
+     * Top border of the task relative to the root svg
+     */
+    y: number;
+    /**
+     * Comparison dates coordinates
+     */
+    comparisonDates?: TaskComparisonDatesCoordinates;
+};
+export interface ExpandedDependency {
+    containerHeight: number;
+    containerY: number;
+    innerFromY: number;
+    innerToY: number;
+    marginBetweenTasks: number | null;
+    ownTarget: RelationMoveTarget;
+    source: Task;
+    sourceTarget: RelationMoveTarget;
+}
+/**
+ * comparison level -> task id -> {
+ *   x1: number;
+ *   x2: number;
+ *   y: number;
+ * }
+ */
+export type MapTaskToCoordinates = Map<number, Map<string, TaskCoordinates>>;
+export type TaskToGlobalIndexMap = Map<number, Map<string, number>>;
+export type TaskToRowIndexMap = Map<number, Map<string, number>>;
+export type RowIndexToTaskMap = Map<number, Map<number, RenderTask>>;
+export type GlobalRowIndexToTaskMap = Map<number, RenderTask>;
+export type TaskMapByLevel = Map<number, Map<string, RenderTask>>;
+export type MapTaskToNestedIndex = Map<number, Map<string, [number, string]>>;
+export type DependencyMap = Map<number, Map<string, ExpandedDependency[]>>;
+export type DependentMap = Map<number, Map<string, ExpandedDependent[]>>;
+export type DependencyMargins = Map<number, Map<string, Map<string, number>>>;
+export type CriticalPath = {
+    tasks: Set<string>;
+    dependencies: Map<string, Set<string>>;
+};
+export interface TaskListTableProps {
+    ganttRef: RefObject<HTMLDivElement>;
+    getTableRowProps: (task: RenderTask, index: number) => TaskListTableRowProps;
+    canMoveTasks: boolean;
+    allowMoveTask: AllowReorderTask;
+    childTasksMap: ChildByLevelMap;
+    columns: readonly Column[];
+    cutIdsMirror: Readonly<Record<string, true>>;
+    dateSetup: DateSetup;
+    dependencyMap: DependencyMap;
+    distances: Distances;
+    fullRowHeight: number;
+    ganttFullHeight: number;
+    getTaskCurrentState: (task: Task) => Task;
+    handleAddTask: (task: Task) => void;
+    handleDeleteTasks: (task: RenderTask[]) => void;
+    handleEditTask: (task: RenderTask) => void;
+    handleMoveTaskBefore: (target: RenderTask, taskForMove: RenderTask) => void;
+    handleMoveTaskAfter: (target: RenderTask, taskForMove: RenderTask) => void;
+    handleMoveTasksInside: (parent: Task, childs: readonly RenderTask[]) => void;
+    handleOpenContextMenu: (task: RenderTask, clientX: number, clientY: number) => void;
+    icons?: Partial<GanttRenderIconsProps>;
+    isShowTaskNumbers: boolean;
+    mapTaskToNestedIndex: MapTaskToNestedIndex;
+    onClick: (task: RenderTask) => void;
+    onExpanderClick: (task: Task) => void;
+    renderedIndexes: OptimizedListParams | null;
+    scrollToTask: (task: Task) => void;
+    selectTaskOnMouseDown: (taskId: string, event: MouseEvent) => void;
+    selectedIdsMirror: Readonly<Record<string, true>>;
+    taskListWidth: number;
+    tasks: readonly RenderTask[];
+}
+export type TaskListTableRowProps = {
+    columns: readonly Column[];
+    dateSetup: DateSetup;
+    dependencyMap: DependencyMap;
+    depth: number;
+    distances: Distances;
+    fullRowHeight: number;
+    getTaskCurrentState: (task: Task) => Task;
+    handleAddTask: (task: Task) => void;
+    handleDeleteTasks: (task: RenderTask[]) => void;
+    handleEditTask: (task: RenderTask) => void;
+    moveHandleProps?: any;
+    moveOverPosition?: InsertTaskPosition;
+    handleOpenContextMenu: (task: RenderTask, clientX: number, clientY: number) => void;
+    hasChildren: boolean;
+    icons?: Partial<GanttRenderIconsProps>;
+    indexStr: string;
+    isDragging?: boolean;
+    isOverlay?: boolean;
+    isClosed: boolean;
+    isCut: boolean;
+    isEven: boolean;
+    isSelected: boolean;
+    isShowTaskNumbers: boolean;
+    onClick: (task: RenderTask) => void;
+    onExpanderClick: (task: Task) => void;
+    scrollToTask: (task: Task) => void;
+    selectTaskOnMouseDown: (taskId: string, event: MouseEvent) => void;
+    style?: CSSProperties;
+    task: RenderTask;
+};
+export interface TaskListHeaderProps {
+    headerHeight: number;
+    columns: readonly Column[];
+    canMoveTasks: boolean;
+    canResizeColumns: boolean;
+    onColumnResizeStart: (columnIndex: number, clientX: number) => void;
+}
+export type MinAndMaxChildsOfTask = [
+    [
+        /**
+         * First min
+         */
+        Task | null,
+        /**
+         * Second min
+         */
+        Task | null
+    ],
+    [
+        /**
+         * First max
+         */
+        Task | null,
+        /**
+         * Second max
+         */
+        Task | null
+    ]
+];
+export type MinAndMaxChildsMap = Map<number, Map<string, MinAndMaxChildsOfTask>>;