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,34 @@
+# Controls
+
+The control panel contains a zoom-in, zoom-out, fit-view and a lock/unlock button.
+
+## Usage
+
+To use the controls simply pass the `Controls` component as a child to the `VueFlow` component.
+
+```vue
+<template>
+  <VueFlow>
+    <Controls />
+  </VueFlow>
+</template>
+```
+
+## Props
+
+| Name            | Definition                | Type                                                                  | Optional | Default |
+|-----------------|---------------------------|-----------------------------------------------------------------------|----------|---------|
+| showZoom        | Show zoom btn             | boolean                                                               | true     | true    |
+| showFitView     | Show fit-view btn         | boolean                                                               | true     | true    |
+| showInteractive | Show lock interactive btn | boolean                                                               | true     | true    |
+| showZoom        | Show zoom button          | boolean                                                               | true     | true    |
+| fitViewParams   | Params to use on fit-view | [FitViewParams](https://types.vueflow.dev/modules.html#FitViewParams) | true     | -       |
+
+## Emits
+
+| Name               | Definition                  |
+|--------------------|-----------------------------|
+| zoom-in            | Zoom-in btn clicked         |
+| zoom-out           | Zoom-out btn clicked        |
+| fit-view           | Fit-view btn clicked        |
+| interaction-change | Interaction locked/unlocked |