alighasami/vue-flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs): fix typo and update title

Browse Source
This commit is contained in:
braks
2024-06-13 22:33:09 +02:00
parent 76fe779f34
commit ff055517cd
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -75,6 +75,7 @@ Nodes additionally need an __XY-position__, while edges require a __source__ and
```vue
<!-- Flowchart.vue -->
<script setup>
import { ref } from 'vue'
import { VueFlow } from '@vue-flow/core'
const nodes = ref([

10
docs/src/guide/getting-started.md
View File

@@ -43,14 +43,14 @@ $ yarn add @vue-flow/core
:::
## Usage
## Quick Start
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node)and [**edges**](/typedocs/types/Edge), all of which are categorised as [**elements**](/typedocs/types/Elements).
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node) and [**edges**](/typedocs/types/Edge).
**Each node and edge requires a unique id.**
**Each node or edge requires a unique id.**
Nodes also need an [XY-position](/typedocs/interfaces/XYPosition), while edges require a `source` and a
`target`, both represented by node ids.
Nodes also need a [XY-position](/typedocs/interfaces/XYPosition), while edges require a `source` and a
`target` node id.
::: warning NOTE!
To ensure Vue Flow's is correctly displayed, make sure you include the necessary styles.

3
docs/src/guide/node.md
View File

@@ -62,8 +62,7 @@ For the full list of options available for a node, check out the [Node Interface
## Adding Nodes to the Graph
Nodes are generally created by adding them to the `mode-value` (using `v-model`) or to the `nodes` prop of the Vue Flow component.
This can be done dynamically at any point in your component's lifecycle.
Nodes are rendered by passing them to the `nodes` prop (or the deprecated `v-model` prop) of the Vue Flow component.
:::code-group