@ganttloom/gantt-vue 0.2.0

package/dist/index.d.cts

@@ -0,0 +1,456 @@
+import * as vue from 'vue';
+import { ExtractPropTypes, PropType, ShallowRef, Ref } from 'vue';
+import { GanttTask, GanttDependency, ViewMode, GanttColumn, GanttTheme, WorkingCalendar, GanttMarker, ResourceHistogramOptions, ResourceLoadBucket, ResourceLevelingOptions, ResourceLevelingResult, GanttRenderModel, GanttChart as GanttChart$1, GanttOptions } from '@ganttloom/gantt-core';
+export { ConstraintType, DEFAULT_PALETTE, DENSITY_PRESETS, Density, DependencyType, FilterTasksOptions, FilterTasksResult, GanttAssignee, GanttColumn, GanttDependency, GanttEventMap, GanttMarker, GanttOptions, GanttRenderBar, GanttRenderLink, GanttRenderMarker, GanttRenderModel, GanttRenderRow, GanttRenderTick, GanttTask, GanttTheme, ResourceHistogramOptions, ResourceLevelingOptions, ResourceLevelingResult, ResourceLoadBucket, ViewMode, WorkingCalendar, applyColorByField, applyConstraint, colorByField, computeResourceHistogram, computeWBSCodes, filterTasks, isHoliday, isWithinWorkingHours, isWorkingDay, isWorkingTime, levelResources, nextWorkingDay, previousWorkingDay, renderResourceHistogramSVG, shiftToWorkingDay, shiftToWorkingTime } from '@ganttloom/gantt-core';
+
+/** Imperative escape hatches, available via a template ref (see the package README). */
+interface GanttChartHandle {
+    undo(): void;
+    redo(): void;
+    canUndo(): boolean;
+    canRedo(): boolean;
+    expandAll(): void;
+    collapseAll(): void;
+    toggleGroup(taskId: string): void;
+    removeDependency(fromId: string, toId: string): void;
+    updateDependency(fromId: string, toId: string, partial: Partial<GanttDependency>): void;
+    updateTask(id: string, partial: Partial<GanttTask>): void;
+    setViewMode(mode: ViewMode): void;
+    fitToViewport(containerWidthPx: number): void;
+    scrollToToday(): void;
+    scrollToRangeStart(): void;
+    scrollToRangeEnd(): void;
+    getPageCount(): number;
+    setPage(page: number): void;
+    zoomIn(factor?: number): void;
+    zoomOut(factor?: number): void;
+    getZoomLevel(): number;
+    getResourceHistogram(options?: ResourceHistogramOptions): ResourceLoadBucket[];
+    getLeveledTasks(options?: ResourceLevelingOptions): ResourceLevelingResult;
+    selectTask(id: string, options?: {
+        additive?: boolean;
+    }): void;
+    selectAllVisible(): void;
+    clearSelection(): void;
+    getSelectedTaskIds(): string[];
+    bulkShiftDates(deltaMs: number): void;
+    bulkDelete(): void;
+    toSVGString(): string;
+    toPNGDataURL(): Promise<string>;
+    toPNGDataURLs(options?: {
+        pageWidthPx?: number;
+        pageHeightPx?: number;
+    }): Promise<string[]>;
+    getRenderModel(): GanttRenderModel | null;
+    /** Direct access to the underlying framework-agnostic core instance (null before mount). */
+    getInstance(): GanttChart$1 | null;
+}
+declare const ganttChartProps: {
+    readonly tasks: {
+        readonly type: PropType<GanttTask[]>;
+        readonly required: true;
+    };
+    readonly dependencies: {
+        readonly type: PropType<GanttDependency[]>;
+        readonly default: () => never[];
+    };
+    readonly viewMode: {
+        readonly type: PropType<ViewMode>;
+        readonly default: undefined;
+    };
+    readonly columns: {
+        readonly type: PropType<GanttColumn[]>;
+        readonly default: undefined;
+    };
+    readonly theme: {
+        readonly type: PropType<Partial<GanttTheme>>;
+        readonly default: undefined;
+    };
+    readonly colorScheme: {
+        readonly type: PropType<"light" | "dark" | "auto">;
+        readonly default: undefined;
+    };
+    readonly columnWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly readonly: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDependencies: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly gridPanelWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly showCriticalPath: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showBaseline: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDeadlines: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showAssigneeAvatars: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly enableHistory: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly keyboardAccessible: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly virtualScroll: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly autoSchedule: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pagination: {
+        readonly type: PropType<{
+            pageSize: number;
+            page: number;
+        }>;
+        readonly default: undefined;
+    };
+    readonly snapToUnit: {
+        readonly type: PropType<"hour" | "day" | "week" | false>;
+        readonly default: undefined;
+    };
+    /** working-day/holiday definition used to shade non-working time and (with autoSchedule) skip it when cascading */
+    readonly calendar: {
+        readonly type: PropType<WorkingCalendar>;
+        readonly default: undefined;
+    };
+    /** arbitrary labeled vertical lines on the timeline, independent of any task */
+    readonly markers: {
+        readonly type: PropType<GanttMarker[]>;
+        readonly default: undefined;
+    };
+    /** a group task with no explicit `progress` gets a duration-weighted average of its children's progress instead of 0 */
+    readonly autoRollupProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    /** enables click/ctrl-click/shift-click multi-selection of task bars, and the handle's bulkShiftDates()/bulkDelete() */
+    readonly selectable: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+};
+type GanttChartProps = ExtractPropTypes<typeof ganttChartProps>;
+declare const GanttChart: vue.DefineComponent<ExtractPropTypes<{
+    readonly tasks: {
+        readonly type: PropType<GanttTask[]>;
+        readonly required: true;
+    };
+    readonly dependencies: {
+        readonly type: PropType<GanttDependency[]>;
+        readonly default: () => never[];
+    };
+    readonly viewMode: {
+        readonly type: PropType<ViewMode>;
+        readonly default: undefined;
+    };
+    readonly columns: {
+        readonly type: PropType<GanttColumn[]>;
+        readonly default: undefined;
+    };
+    readonly theme: {
+        readonly type: PropType<Partial<GanttTheme>>;
+        readonly default: undefined;
+    };
+    readonly colorScheme: {
+        readonly type: PropType<"light" | "dark" | "auto">;
+        readonly default: undefined;
+    };
+    readonly columnWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly readonly: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDependencies: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly gridPanelWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly showCriticalPath: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showBaseline: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDeadlines: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showAssigneeAvatars: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly enableHistory: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly keyboardAccessible: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly virtualScroll: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly autoSchedule: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pagination: {
+        readonly type: PropType<{
+            pageSize: number;
+            page: number;
+        }>;
+        readonly default: undefined;
+    };
+    readonly snapToUnit: {
+        readonly type: PropType<"hour" | "day" | "week" | false>;
+        readonly default: undefined;
+    };
+    /** working-day/holiday definition used to shade non-working time and (with autoSchedule) skip it when cascading */
+    readonly calendar: {
+        readonly type: PropType<WorkingCalendar>;
+        readonly default: undefined;
+    };
+    /** arbitrary labeled vertical lines on the timeline, independent of any task */
+    readonly markers: {
+        readonly type: PropType<GanttMarker[]>;
+        readonly default: undefined;
+    };
+    /** a group task with no explicit `progress` gets a duration-weighted average of its children's progress instead of 0 */
+    readonly autoRollupProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    /** enables click/ctrl-click/shift-click multi-selection of task bars, and the handle's bulkShiftDates()/bulkDelete() */
+    readonly selectable: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    "date-change": (_task: GanttTask, _start: Date, _end: Date) => boolean;
+    "progress-change": (_task: GanttTask, _progress: number) => boolean;
+    "dependency-create": (_dep: GanttDependency) => boolean;
+    "dependency-remove": (_dep: GanttDependency) => boolean;
+    "dependency-dblclick": (_dep: GanttDependency) => boolean;
+    "task-click": (_task: GanttTask) => boolean;
+    "group-toggle": (_task: GanttTask, _collapsed: boolean) => boolean;
+    "context-menu": (_task: GanttTask, _evt: PointerEvent) => boolean;
+    "task-create": (_task: GanttTask) => boolean;
+    "column-resize": (_columnId: string, _width: number) => boolean;
+    "column-reorder": (_order: string[]) => boolean;
+    "task-reorder": (_draggedTaskId: string, _targetTaskId: string, _position: "before" | "after" | "inside") => boolean;
+    "selection-change": (_taskIds: string[]) => boolean;
+}, string, vue.PublicProps, Readonly<ExtractPropTypes<{
+    readonly tasks: {
+        readonly type: PropType<GanttTask[]>;
+        readonly required: true;
+    };
+    readonly dependencies: {
+        readonly type: PropType<GanttDependency[]>;
+        readonly default: () => never[];
+    };
+    readonly viewMode: {
+        readonly type: PropType<ViewMode>;
+        readonly default: undefined;
+    };
+    readonly columns: {
+        readonly type: PropType<GanttColumn[]>;
+        readonly default: undefined;
+    };
+    readonly theme: {
+        readonly type: PropType<Partial<GanttTheme>>;
+        readonly default: undefined;
+    };
+    readonly colorScheme: {
+        readonly type: PropType<"light" | "dark" | "auto">;
+        readonly default: undefined;
+    };
+    readonly columnWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly readonly: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDependencies: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly gridPanelWidth: {
+        readonly type: NumberConstructor;
+        readonly default: undefined;
+    };
+    readonly showCriticalPath: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showBaseline: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showDeadlines: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly showAssigneeAvatars: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly enableHistory: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly keyboardAccessible: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly virtualScroll: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly autoSchedule: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    readonly pagination: {
+        readonly type: PropType<{
+            pageSize: number;
+            page: number;
+        }>;
+        readonly default: undefined;
+    };
+    readonly snapToUnit: {
+        readonly type: PropType<"hour" | "day" | "week" | false>;
+        readonly default: undefined;
+    };
+    /** working-day/holiday definition used to shade non-working time and (with autoSchedule) skip it when cascading */
+    readonly calendar: {
+        readonly type: PropType<WorkingCalendar>;
+        readonly default: undefined;
+    };
+    /** arbitrary labeled vertical lines on the timeline, independent of any task */
+    readonly markers: {
+        readonly type: PropType<GanttMarker[]>;
+        readonly default: undefined;
+    };
+    /** a group task with no explicit `progress` gets a duration-weighted average of its children's progress instead of 0 */
+    readonly autoRollupProgress: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+    /** enables click/ctrl-click/shift-click multi-selection of task bars, and the handle's bulkShiftDates()/bulkDelete() */
+    readonly selectable: {
+        readonly type: BooleanConstructor;
+        readonly default: undefined;
+    };
+}>> & Readonly<{
+    "onDate-change"?: ((_task: GanttTask, _start: Date, _end: Date) => any) | undefined;
+    "onProgress-change"?: ((_task: GanttTask, _progress: number) => any) | undefined;
+    "onDependency-create"?: ((_dep: GanttDependency) => any) | undefined;
+    "onDependency-remove"?: ((_dep: GanttDependency) => any) | undefined;
+    "onTask-click"?: ((_task: GanttTask) => any) | undefined;
+    "onTask-create"?: ((_task: GanttTask) => any) | undefined;
+    "onGroup-toggle"?: ((_task: GanttTask, _collapsed: boolean) => any) | undefined;
+    "onContext-menu"?: ((_task: GanttTask, _evt: PointerEvent) => any) | undefined;
+    "onColumn-resize"?: ((_columnId: string, _width: number) => any) | undefined;
+    "onColumn-reorder"?: ((_order: string[]) => any) | undefined;
+    "onDependency-dblclick"?: ((_dep: GanttDependency) => any) | undefined;
+    "onTask-reorder"?: ((_draggedTaskId: string, _targetTaskId: string, _position: "before" | "after" | "inside") => any) | undefined;
+    "onSelection-change"?: ((_taskIds: string[]) => any) | undefined;
+}>, {
+    readonly viewMode: ViewMode;
+    readonly columns: GanttColumn[];
+    readonly theme: Partial<GanttTheme>;
+    readonly colorScheme: "light" | "dark" | "auto";
+    readonly columnWidth: number;
+    readonly readonly: boolean;
+    readonly showProgress: boolean;
+    readonly showDependencies: boolean;
+    readonly gridPanelWidth: number;
+    readonly showCriticalPath: boolean;
+    readonly showBaseline: boolean;
+    readonly showDeadlines: boolean;
+    readonly showAssigneeAvatars: boolean;
+    readonly calendar: WorkingCalendar;
+    readonly markers: GanttMarker[];
+    readonly autoRollupProgress: boolean;
+    readonly selectable: boolean;
+    readonly enableHistory: boolean;
+    readonly keyboardAccessible: boolean;
+    readonly virtualScroll: boolean;
+    readonly pagination: {
+        pageSize: number;
+        page: number;
+    };
+    readonly snapToUnit: false | "hour" | "day" | "week";
+    readonly autoSchedule: boolean;
+    readonly dependencies: GanttDependency[];
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+
+interface UseGanttChartResult {
+    /** The underlying framework-agnostic GanttChart instance, or null before the mount effect runs. */
+    chart: ShallowRef<GanttChart$1 | null>;
+    /** Reactive, subscribed to the core's "history-change" event. Only meaningful when `enableHistory` is set in options. */
+    canUndo: Ref<boolean>;
+    /** Reactive, subscribed to the core's "history-change" event. Only meaningful when `enableHistory` is set in options. */
+    canRedo: Ref<boolean>;
+}
+/**
+ * Lower-level escape hatch for consumers who want to own their own container element
+ * and DOM tree instead of using the <GanttChart /> component. Constructs a
+ * @ganttloom/gantt-core GanttChart instance against `containerRef.value` on mount,
+ * keeps it in sync with the tasks/dependencies/options getters via setTasks / setDependencies /
+ * setOptions (reference-equality checks only — return a new array/object to trigger a sync),
+ * and destroys it on unmount.
+ *
+ * `getTasks`/`getDependencies`/`getOptions` are plain functions (not refs) so this composable
+ * can track whatever reactive source each one reads — a prop, a ref, a computed — without
+ * imposing a shape on the caller.
+ */
+declare function useGanttChart(containerRef: Ref<HTMLElement | null>, getTasks: () => GanttTask[], getDependencies: () => GanttDependency[], getOptions: () => GanttOptions): UseGanttChartResult;
+
+export { GanttChart, type GanttChartHandle, type GanttChartProps, type UseGanttChartResult, GanttChart as default, useGanttChart };