From 15ca63a59c6eb5691339dca01b52272020845a9f Mon Sep 17 00:00:00 2001 From: braks <78412429+bcakmakoglu@users.noreply.github.com> Date: Wed, 14 Dec 2022 12:57:56 +0100 Subject: [PATCH] docs: update component documentation with new examples Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com> --- docs/src/guide/components/background.md | 13 +++++++++++-- docs/src/guide/components/controls.md | 21 ++++++++++++++++++++- docs/src/guide/components/minimap.md | 19 ++++++++++++++++++- packages/background/README.md | 1 - packages/controls/README.md | 1 - packages/minimap/README.md | 1 - 6 files changed, 49 insertions(+), 7 deletions(-) diff --git a/docs/src/guide/components/background.md b/docs/src/guide/components/background.md index ad2df072..381a6fca 100644 --- a/docs/src/guide/components/background.md +++ b/docs/src/guide/components/background.md @@ -16,9 +16,18 @@ npm install @vue-flow/background To use the background simply pass the `Background` component as a child to the `VueFlow` component. ```vue + + ``` diff --git a/docs/src/guide/components/controls.md b/docs/src/guide/components/controls.md index b3af8fb2..756c4455 100644 --- a/docs/src/guide/components/controls.md +++ b/docs/src/guide/components/controls.md @@ -15,14 +15,33 @@ npm install @vue-flow/controls To use the controls simply pass the `Controls` component as a child to the `VueFlow` component. +::: warning +Make sure you also import the styles as these are *not* part of the default theme anymore. +::: + ```vue + + ``` + ## [Props](/typedocs/interfaces/ControlProps) | Name | Definition | Type | Optional | Default | diff --git a/docs/src/guide/components/minimap.md b/docs/src/guide/components/minimap.md index 683b199a..a0721ffd 100644 --- a/docs/src/guide/components/minimap.md +++ b/docs/src/guide/components/minimap.md @@ -13,9 +13,26 @@ npm install @vue-flow/minimap To use the minimap simply pass the `MiniMap` component as a child to the `VueFlow` component. +::: warning +Make sure you also import the styles as these are *not* part of the default theme anymore. +::: + ```vue + + diff --git a/packages/background/README.md b/packages/background/README.md index 82251afb..177b637c 100644 --- a/packages/background/README.md +++ b/packages/background/README.md @@ -16,7 +16,6 @@ $ npm i --save @vue-flow/background ## 🎮 Quickstart ```vue -