docs: Add additional component pages

2022-04-04 21:42:48 +02:00
parent 0291f771fb
commit b2375bd81a
4 changed files with 92 additions and 0 deletions
@@ -0,0 +1,24 @@
+# MiniMap
+
+## Usage
+
+To use the minimap simply pass the `MiniMap` component as a child to the `VueFlow` component.
+
+```vue
+<template>
+  <VueFlow>
+    <MiniMap />
+  </VueFlow>
+</template>
+```
+
+## Props
+
+| Name             | Definition               | Type                                                                         | Optional | Default                 |
+|------------------|--------------------------|------------------------------------------------------------------------------|----------|-------------------------|
+| nodeColor        | Node(s) Background color | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | true     | #fff                    |
+| nodeStrokeColor  | Border color             | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | true     | #555                    |
+| nodeClassName    | Extra classes            | string, [MiniMapNodeFunc](https://types.vueflow.dev/modules.html#StringFunc) | true     | -                       |
+| nodeBorderRadius | Border radius            | number                                                                       | true     | 5                       |
+| nodeStrokeWidth  | Stroke width             | number                                                                       | true     | 2                       |
+| maskColor        | Minimap Background color | string                                                                       | true     | rgb(240, 242, 243, 0.7) |