@awaddev/vue-flow
v1.27.2
Published
[](https://vueflow.dev/)    more to come...
🦾 Reliable: Fully written in TypeScript
🛠 Setup
$ npm i @vue-flow/core
# or
$ yarn add @vue-flow/core
🎮 Quickstart
A flow consists of nodes and edges (or just nodes). Together they are called elements.
Each element needs a unique id.
A node also needs an XY position. An edge needs a source (node id) and a target (node id).
A basic setup looks like this:
<!-- Flowchart.vue -->
<script setup>
import { VueFlow } from '@vue-flow/core'
const elements = ref([
{
id: '1',
label: 'node 1',
position: { x: 100, y: 100 },
},
{
id: '2',
label: 'node 2',
position: { x: 100, y: 200 },
},
{
id: 'e1-2',
target: '2',
source: '1',
},
])
</script>
<template>
<VueFlow v-model="elements"></VueFlow>
</template>
⚠️ Make sure to import the necessary styles:
/* import the required styles */
@import "@vue-flow/core/dist/style.css";
/* import the default theme (optional) */
@import "@vue-flow/core/dist/theme-default.css";
🪴 Vue 2
This library doesn't work with Vue 2.
Vue Flow uses features that are exclusive to Vue 3, therefore there is no support for Vue 2, nor will there be any support in the future, sorry.
🧪 Development
Prerequisites
# skip if you already have pnpm installed
$ npm i -g pnpm
# start examples
$ pnpm dev
# build all packages
$ pnpm build
🐳 Dev Container
To start using development containers, install the Docker
extension
for VSCode.
After installing the extension, open the connection menu either
on the bottom left or open it via the commands tab.
Select the Open Folder in Container
option to mount the project.
The development container will spin up all packages example apps and forward the ports to your machine.
Discord
Join the Vue Flow Discord server!
Here you can ask questions to the community, propose ideas for new features or share your work that you have built with Vue Flow.
💝 Special Thanks
This project is built with
- Vue flow is heavily based on webkids' react flow. I wholeheartedly thank them for their amazing work! Without them Vue Flow would not exist. Please consider donating to them.
- D3 makes all the zoom and pan actions in Vue Flow possible.
- VueUse is a collection of essential vue composition utilities
⭐ Stargazers
Many thanks to the kind individuals who leave a star. Your support is much appreciated!