alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(types): cleanup comments

Browse Source
This commit is contained in:
moklick
2024-01-16 18:09:54 +01:00
parent 897c9afdf6
commit 25576cd5d5
18 changed files with 178 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/svelte/src/lib/plugins/Minimap/types.ts
+17 -17
View File
@@ -5,45 +5,45 @@ import type { Node } from '$lib/types';
export type GetMiniMapNodeAttribute = (node: Node) => string;
export type MiniMapProps = {
/** background color of minimap */
/** Background color of minimap */
bgColor?: string;
/** color of nodes on the minimap */
/** Color of nodes on the minimap */
nodeColor?: string | GetMiniMapNodeAttribute;
/** stroke color of nodes on the minimap */
/** Stroke color of nodes on the minimap */
nodeStrokeColor?: string | GetMiniMapNodeAttribute;
/** class applied to nodes on the minimap */
/** Class applied to nodes on the minimap */
nodeClass?: string | GetMiniMapNodeAttribute;
/** border radius of nodes on the minimap */
/** Border radius of nodes on the minimap */
nodeBorderRadius?: number;
/** stroke width of nodes on the minimap */
/** Stroke width of nodes on the minimap */
nodeStrokeWidth?: number;
/** color of the mask representing viewport */
/** Color of the mask representing viewport */
maskColor?: string;
/** stroke color of the mask representing viewport */
/** Stroke color of the mask representing viewport */
maskStrokeColor?: string;
/** stroke width of the mask representing viewport */
/** Stroke width of the mask representing viewport */
maskStrokeWidth?: number;
/** position of the minimap on the pane
/** Position of the minimap on the pane
* @example PanelPosition.TopLeft, PanelPosition.TopRight,
* PanelPosition.BottomLeft, PanelPosition.BottomRight
*/
position?: PanelPosition;
/** class applied to container */
/** Class applied to container */
class?: string;
/** style applied to container */
/** Style applied to container */
style?: string;
/** aria-label applied to container */
/** The aria-label applied to container */
ariaLabel?: string | null;
/** width of minimap */
/** Width of minimap */
width?: number;
/** height of minimap */
/** Height of minimap */
height?: number;
// onClick?: (event: MouseEvent, position: XYPosition) => void;
// onNodeClick?: (event: MouseEvent, node: Node) => void;
pannable?: boolean;
zoomable?: boolean;
/** invert the direction when panning the minimap viewport */
/** Invert the direction when panning the minimap viewport */
inversePan?: boolean;
/** step size for zooming in/out */
/** Step size for zooming in/out */
zoomStep?: number;
};