hy-vue-gantt
Version:
Evolution of vue-ganttastic package
29 lines • 1.33 kB
TypeScript
import type { BarConnection } from "../types";
import { type Ref } from "vue";
/**
* Interface defining the navigation control methods and state
* Contains the essential methods and values needed for keyboard-based navigation
*/
interface NavigationControls {
scrollPosition: Ref<number>;
handleStep: (value: number, wrapper: HTMLElement) => void;
handleZoomUpdate: (increase: boolean) => void;
}
interface ConnectionControls {
selectedConnection: Ref<BarConnection | null>;
deleteSelectedConnection: () => void;
}
/**
* A composable that provides keyboard navigation functionality for the Gantt chart
* Allows users to navigate and control the chart using keyboard shortcuts
*
* @param chartNavigation - Object containing navigation control methods
* @param wrapperRef - Reference to the chart wrapper element
* @param ganttContainerRef - Reference to the main Gantt container
* @returns Object containing keyboard event handler
*/
export declare function useKeyboardNavigation(chartNavigation: NavigationControls, wrapperRef: Ref<HTMLElement | null>, ganttContainerRef: Ref<HTMLElement | null>, connectionControls: ConnectionControls, enableConnectionDeletion: Ref<boolean>): {
handleKeyDown: (event: KeyboardEvent) => void;
};
export {};
//# sourceMappingURL=useKeyboardNavigation.d.ts.map