@vue-flow/minimap
Version:
This is a minimap component for Vue Flow. It can be used to add a minimap to the canvas, which will show a smaller version of the canvas with your nodes. The minimap can also be used to pan and zoom the main canvas.
168 lines (166 loc) • 4.88 kB
TypeScript
import type { PanelPosition } from '@vue-flow/core'
import type { MiniMapNodeFunc, MiniMapSlots } from './types'
declare const _default: __VLS_WithTemplateSlots<
import('vue').DefineComponent<
{
nodeColor: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeStrokeColor: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeClassName: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeBorderRadius: {
type: import('vue').PropType<number>
}
nodeStrokeWidth: {
type: import('vue').PropType<number>
}
maskColor: {
type: import('vue').PropType<string>
}
maskStrokeColor: {
type: import('vue').PropType<string>
}
maskStrokeWidth: {
type: import('vue').PropType<number>
}
position: {
type: import('vue').PropType<import('@vue-flow/core').PanelPositionType | PanelPosition>
}
pannable: {
type: import('vue').PropType<boolean>
}
zoomable: {
type: import('vue').PropType<boolean>
}
width: {
type: import('vue').PropType<number>
}
height: {
type: import('vue').PropType<number>
}
ariaLabel: {
type: import('vue').PropType<string | null>
}
inversePan: {
type: import('vue').PropType<boolean>
}
zoomStep: {
type: import('vue').PropType<number>
}
offsetScale: {
type: import('vue').PropType<number>
}
maskBorderRadius: {
type: import('vue').PropType<number>
}
},
{},
unknown,
{},
{},
import('vue').ComponentOptionsMixin,
import('vue').ComponentOptionsMixin,
{
click: (params: {
event: MouseEvent
position: {
x: number
y: number
}
}) => void
nodeClick: (params: import('@vue-flow/core').NodeMouseEvent) => void
nodeDblclick: (params: import('@vue-flow/core').NodeMouseEvent) => void
nodeMouseenter: (params: import('@vue-flow/core').NodeMouseEvent) => void
nodeMousemove: (params: import('@vue-flow/core').NodeMouseEvent) => void
nodeMouseleave: (params: import('@vue-flow/core').NodeMouseEvent) => void
},
string,
import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps,
Readonly<
import('vue').ExtractPropTypes<{
nodeColor: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeStrokeColor: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeClassName: {
type: import('vue').PropType<string | MiniMapNodeFunc>
}
nodeBorderRadius: {
type: import('vue').PropType<number>
}
nodeStrokeWidth: {
type: import('vue').PropType<number>
}
maskColor: {
type: import('vue').PropType<string>
}
maskStrokeColor: {
type: import('vue').PropType<string>
}
maskStrokeWidth: {
type: import('vue').PropType<number>
}
position: {
type: import('vue').PropType<import('@vue-flow/core').PanelPositionType | PanelPosition>
}
pannable: {
type: import('vue').PropType<boolean>
}
zoomable: {
type: import('vue').PropType<boolean>
}
width: {
type: import('vue').PropType<number>
}
height: {
type: import('vue').PropType<number>
}
ariaLabel: {
type: import('vue').PropType<string | null>
}
inversePan: {
type: import('vue').PropType<boolean>
}
zoomStep: {
type: import('vue').PropType<number>
}
offsetScale: {
type: import('vue').PropType<number>
}
maskBorderRadius: {
type: import('vue').PropType<number>
}
}>
> & {
onClick?:
| ((params: {
event: MouseEvent
position: {
x: number
y: number
}
}) => any)
| undefined
onNodeClick?: ((params: import('@vue-flow/core').NodeMouseEvent) => any) | undefined
onNodeDblclick?: ((params: import('@vue-flow/core').NodeMouseEvent) => any) | undefined
onNodeMouseenter?: ((params: import('@vue-flow/core').NodeMouseEvent) => any) | undefined
onNodeMousemove?: ((params: import('@vue-flow/core').NodeMouseEvent) => any) | undefined
onNodeMouseleave?: ((params: import('@vue-flow/core').NodeMouseEvent) => any) | undefined
},
{},
{}
>,
Readonly<MiniMapSlots>
>
export default _default
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S
}
}