Skip to content

Commit

Permalink
chore: add changeset
Browse files Browse the repository at this point in the history
Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
  • Loading branch information
bcakmakoglu committed Dec 25, 2022
1 parent c1a6945 commit bac9893
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions .changeset/chatty-ducks-fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
'@vue-flow/core': patch
---

鈿狅笍 Deprecate options API utils `addEdge` and `updateEdge`. This utils will be removed soon!

## Resolve deprecation warnings

Instead of using these utils, use `addEdges` and `updateEdge` found on the VueFlow store instance.
You receive a store instance by using either a template-ref or listening to the `onPaneReady` event.

### Example

```vue
<script>
import { VueFlow } from '@vue-flow/core'
export default defineComponent({
name: 'OptionsAPIExample',
components: { VueFlow },
data() {
return {
vueFlow: null,
instance: null,
elements: [
{ id: '1', type: 'input', label: 'Node 1', position: { x: 250, y: 5 }, class: 'light' },
{ id: '2', label: 'Node 2', position: { x: 100, y: 100 }, class: 'light' },
{ id: '3', label: 'Node 3', position: { x: 400, y: 100 }, class: 'light' },
{ id: '4', label: 'Node 4', position: { x: 400, y: 200 }, class: 'light' },
{ id: 'e1-2', source: '1', target: '2', animated: true },
{ id: 'e1-3', source: '1', target: '3' },
],
}
},
methods: {
// You can listen to `onPaneReady` to get the instance
onPaneReady(instance) {
instance.fitView()
this.instance = instance
},
onConnect(params) {
// either use the instance you have saved in `onPaneReady`
this.instance?.addEdges([params])
// or use the template-ref
this.$refs.vueFlow?.addEdges([params])
},
},
})
</script>
<template>
<VueFlow
v-model="elements"
ref="vueFlow"
class="vue-flow-basic-example"
:default-zoom="1.5"
:min-zoom="0.2"
:max-zoom="4"
:zoom-on-scroll="false"
@connect="onConnect"
@pane-ready="onPaneReady"
/>
</template>
```

0 comments on commit bac9893

Please sign in to comment.