alighasami/vue-flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add documentation for MiniMapNode

Browse Source
This commit is contained in:
bcakmakoglu
2022-06-15 12:36:41 +02:00
committed by Braks
parent e469708b57
commit 3587478e5f
1 changed files with 51 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
docs/src/guide/components/minimap-node.md Normal file
View File

@@ -0,0 +1,51 @@
# MiniMap Node
## Usage
To use the component pass the `MiniMapNode` as a child to the [`MiniMap`](/guide/components/minimap.html/) component.
```vue
<template>
<VueFlow>
<MiniMap>
<template #node-input="props">
<MiniMapNode v-bind="props" />
</template>
</MiniMap>
</VueFlow>
</template>
```
## Props
id: string
parentNode?: string
selected?: boolean
dragging?: boolean
position: XYPosition
dimensions: Dimensions
borderRadius?: number
color?: string
shapeRendering?: ShapeRendering
strokeColor?: string
strokeWidth?: number
| Name | Definition | Type | Optional | Default |
|----------------|---------------------------------|-----------------------------------------------------|----------|---------|
| id | Node id | string | false | - |
| parentNode | Parent node id | string | true | - |
| selected | Is node selected | boolean | true | false |
| dragging | Is node dragging | boolean | true | false |
| position | XY position of node | [XYPosition](/typedocs/interfaces/XYPosition.html/) | false | - |
| dimensions | Node dimensions | [Dimensions](/typedocs/interfaces/Dimensions.html/) | false | - |
| borderRadius | MiniMap node css border-radius | number | true | - |
| color | MiniMap node css color | string | true | - |
| shapeRendering | MiniMap node css shapeRendering | ShapeRendering | true | - |
| strokeColor | MiniMap node css stroke-color | string | true | - |
| strokeWidth | MiniMap node css stroke-width | string | true | - |
## Slots
| Name | Definition |
|---------|------------------------------|
| default | Slot below MiniMap node rect |