docs: add documentation for MiniMapNode

bcakmakoglu · Jun 15, 2022 · 3587478 · 3587478
1 parent e469708
commit 3587478
Showing 1 changed file with 51 additions and 0 deletions.
diff --git a/docs/src/guide/components/minimap-node.md b/docs/src/guide/components/minimap-node.md
@@ -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 |