Skip to content

Commit 36d8a7d

Browse files
committed
chore(background): update README.md
Signed-off-by: braks <[email protected]>
1 parent bf1b7e5 commit 36d8a7d

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

packages/background/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
# Vue Flow: Background Component
22

3-
> [!WARNING] DEPRECATED
4-
> This package has been deprecated. Please use the `<Background>` component export directly from the core pkg `import { Background } from '@vue-flow/core'`
3+
> [!WARNING]
4+
> This package has been deprecated.
5+
> Please import the `<Background>` component from `@vue-flow/core`
6+
> ```vue
7+
> <script setup>
8+
> import { VueFlow, Background } from '@vue-flow/core'
9+
> // ...
10+
> </script>
11+
>
12+
> <template>
13+
> <VueFlow :nodes="nodes" :edges="edges">
14+
> <Background />
15+
> </VueFlow>
16+
> </template>
17+
> ```
518
619
This is a background component for Vue Flow.
720
It can be used to create a background in your canvas.

0 commit comments

Comments
 (0)