refactor(types): add useZoomPanHelperFunc types

xyflow · Dec 3, 2021 · 5fbf3d8 · 5fbf3d8
1 parent 8710130
commit 5fbf3d8
Showing 1 changed file with 18 additions and 6 deletions.
diff --git a/src/types/general.ts b/src/types/general.ts
@@ -64,6 +64,7 @@ export type FitViewParams = {
   includeHiddenNodes?: boolean;
   minZoom?: number;
   maxZoom?: number;
+  duration?: number;
 };
 
 export type OnConnectStartParams = {
@@ -105,14 +106,25 @@ export enum PanOnScrollMode {
   Horizontal = 'horizontal',
 }
 
+export type ZoomPanHelperFunctionOptions = {
+  duration?: number;
+};
+
+export type SetCenterOptions = ZoomPanHelperFunctionOptions & {
+  zoom?: number;
+};
+
+export type FitBoundsOptions = ZoomPanHelperFunctionOptions & {
+  padding?: number;
+};
 export interface ZoomPanHelperFunctions {
-  zoomIn: () => void;
-  zoomOut: () => void;
-  zoomTo: (zoomLevel: number) => void;
-  transform: (transform: FlowTransform) => void;
+  zoomIn: (options?: ZoomPanHelperFunctionOptions) => void;
+  zoomOut: (options?: ZoomPanHelperFunctionOptions) => void;
+  zoomTo: (zoomLevel: number, options?: ZoomPanHelperFunctionOptions) => void;
+  transform: (transform: FlowTransform, options?: ZoomPanHelperFunctionOptions) => void;
   fitView: FitView;
-  setCenter: (x: number, y: number, zoom?: number) => void;
-  fitBounds: (bounds: Rect, padding?: number) => void;
+  setCenter: (x: number, y: number, options?: SetCenterOptions) => void;
+  fitBounds: (bounds: Rect, options?: FitBoundsOptions) => void;
   project: (position: XYPosition) => XYPosition;
   initialized: boolean;
 }