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

init commit

Browse Source
This commit is contained in:
alighasami
2026-03-17 16:28:59 +03:30
parent 782aeab2eb
commit cd63e3d0b0
14 changed files with 22513 additions and 6945 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16272
_pnpm-lock.yaml generated Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/package.json
View File

@@ -34,7 +34,7 @@
"dotenv": "^16.4.5",
"ohmyfetch": "^0.4.21",
"typedoc": "^0.26.11",
"typedoc-plugin-markdown": "^4.2.10",
"typedoc-plugin-markdown": "4.2.10",
"typedoc-plugin-merge-modules": "^6.0.3",
"unplugin-auto-import": "^0.18.3",
"unplugin-icons": "^0.20.0",

20
packages/background/LICENSE Normal file
View File

@@ -0,0 +1,20 @@
Copyright (c) 2019-2024 webkid GmbH
Copyright (c) 2021-2024 Burak Cakmakoglu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

32
packages/background/package.json
View File

@@ -45,6 +45,21 @@
"*.d.ts"
],
"sideEffects": false,
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
},
"devDependencies": {
"vue-tsc": "^1.8.16",
"@tooling/eslint-config": "0.0.0",
"@tooling/tsconfig": "0.0.0",
"@tooling/vite-config": "0.0.0",
"@vue-flow/core": "1.41.5"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
@@ -54,20 +69,5 @@
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
},
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
},
"devDependencies": {
"@tooling/eslint-config": "workspace:*",
"@tooling/tsconfig": "workspace:*",
"@tooling/vite-config": "workspace:*",
"@vue-flow/core": "workspace:*",
"vue-tsc": "^1.8.16"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
}

20
packages/controls/LICENSE Normal file
View File

@@ -0,0 +1,20 @@
Copyright (c) 2019-2025 webkid GmbH
Copyright (c) 2021-2025 Burak Cakmakoglu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

34
packages/controls/package.json
View File

@@ -48,6 +48,22 @@
"sideEffects": [
"*.css"
],
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
},
"devDependencies": {
"vite-svg-loader": "^4.0.0",
"vue-tsc": "^1.8.16",
"@tooling/eslint-config": "0.0.0",
"@tooling/tsconfig": "0.0.0",
"@tooling/vite-config": "0.0.0",
"@vue-flow/core": "1.45.1"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
@@ -57,21 +73,5 @@
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
},
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
},
"devDependencies": {
"@tooling/eslint-config": "workspace:*",
"@tooling/tsconfig": "workspace:*",
"@tooling/vite-config": "workspace:*",
"@vue-flow/core": "workspace:*",
"vite-svg-loader": "^4.0.0",
"vue-tsc": "^1.8.16"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
}
}
}

20
packages/core/LICENSE Normal file
View File

@@ -0,0 +1,20 @@
Copyright (c) 2019-2025 webkid GmbH
Copyright (c) 2021-2025 Burak Cakmakoglu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

174
packages/core/README.md Normal file
View File

@@ -0,0 +1,174 @@
# Vue Flow 🌊
[![Vue flow](vue-flow.gif)](https://vueflow.dev/)
![top-language](https://img.shields.io/github/languages/top/bcakmakoglu/vue-flow)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/bcakmakoglu/vue-flow)
![GitHub last commit](https://img.shields.io/github/last-commit/bcakmakoglu/vue-flow)
__Vue Flow: A highly customizable Vue 3 Flowchart component.__
You can find a detailed explanation on how to get started [here](https://vueflow.dev/guide/)
or jump right into the [examples](https://vueflow.dev/examples/).
## Table of contents
* [⭐️ Features](#-features)
* [🛠 Setup](#-setup)
* [🎮 Quickstart](#-quickstart)
+ [🪴 Vue 2](#-vue-2)
* [🧪 Development](#-development)
+ [🐳 Dev Container](#-dev-container)
* [![discord logo](https://api.iconify.design/logos:discord-icon.svg) Discord](#-discord)
* [💝 Special Thanks](#-special-thanks)
* [⭐ Stargazers](#-stargazers)
## ⭐️ Features
- 👶 __Easy setup__: Get started hassle-free - Built-in zoom- & pan features, element dragging, selection and much more
- 🎨 __Customizable__: Use your custom nodes, edges and connection lines and expand on Vue Flows' functionality
- 🚀 __Fast__: Tracks changes reactively and only re-renders the appropriate elements
- 🧲 __Utils & Composition__: Comes with graph helper and state composable functions for advanced uses
- 📦 __Additional Components__:
- 🖼 Background: With two built-in patterns and some configuration options like height, width or color.
- 🧭 Minimap: Shows current nodes in a small map shape in the bottom right corner
- 🕹 Controls: Control zoom behavior from a panel on the bottom left
- 🤖 And (many) more to come...
- 🦾 __Reliable__: Fully written in TypeScript
## 🛠 Setup
```bash
$ npm i @vue-flow/core
# or
$ pnpm i @vue-flow/core
# or
$ yarn add @vue-flow/core
```
## 🎮 Quickstart
In Vue Flow, an application structure consists of __nodes__ and __edges__, all of which are categorised as __elements__.
__Each element requires a unique id.__
Nodes additionally need an __XY-position__, while edges require a __source__ and a __target__, both represented by node ids.
```vue
<!-- Flowchart.vue -->
<script setup>
import { ref } from 'vue'
import { VueFlow } from '@vue-flow/core'
const nodes = ref([
{ id: '1', type: 'input', label: 'Node 1', position: { x: 250, y: 5 } },
{ id: '2', label: 'Node 2', position: { x: 100, y: 100 } },
{ id: '3', label: 'Node 3', position: { x: 400, y: 100 } },
{ id: '4', label: 'Node 4', position: { x: 400, y: 200 } },
])
const edges = ref([
{ id: 'e1-2', source: '1', target: '2', animated: true },
{ id: 'e1-3', source: '1', target: '3' },
])
</script>
<template>
<VueFlow v-model:nodes="nodes" v-model:edges="edges"></VueFlow>
</template>
```
⚠️ __Make sure to import the necessary styles:__
```css
/* import the required styles */
@import "@vue-flow/core/dist/style.css";
/* import the default theme (optional) */
@import "@vue-flow/core/dist/theme-default.css";
```
Do __not__ scope these styles with `scoped` in your component.
### 🪴 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
- [Node.js v20+](https://nodejs.org/)
- [pnpm v9+](https://pnpm.io/)
```bash
# install pnpm if you haven't already
$ 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 logo](https://api.iconify.design/logos:discord-icon.svg) Discord
[Join the Vue Flow Discord server!](https://discord.gg/rwt6CBk4b5)
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
- [React Flow](https://reactflow.dev/)
- Vue flow is heavily based on [webkids'](https://webkid.io/) [ReactFlow](https://reactflow.dev/). I wholeheartedly
thank them for their amazing work! Without them VueFlow would not exist.
Please consider [donating](https://github.com/sponsors/wbkd) or subscribing to [ReactFlow Pro](https://reactflow.dev/pro).
- [D3.js](https://d3js.org/)
- D3 makes all the zoom and pan actions in Vue Flow possible.
- [VueUse](https://vueuse.org/)
- 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!
[![Stargazers for @vue-flow/core](https://reporoster.com/stars/bcakmakoglu/vue-flow)](https://github.com/bcakmakoglu/vue-flow/stargazers)

34
packages/core/package.json
View File

@@ -1,6 +1,6 @@
{
"name": "@vue-flow/core",
"version": "1.48.2",
"version": "1.48.0",
"private": false,
"license": "MIT",
"author": "Burak Cakmakoglu<78412429+bcakmakoglu@users.noreply.github.com>",
@@ -54,19 +54,6 @@
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build && vite build -c vite.config.iife.ts",
"build:watch": "vite build --watch & vite build -c vite.config.iife.ts --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && tsc -p ./tsconfig.build.json && shx rm -rf tmp && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch & tsc -p ./tsconfig.build.json --watch",
"theme": "postcss src/style.css -o dist/style.css && postcss src/theme-default.css -o dist/theme-default.css",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"prepublishOnly": "shx cp ../../README.md .",
"postpublish": "shx rm README.md",
"test": "exit 0"
},
"peerDependencies": {
"vue": "^3.3.0"
},
@@ -79,8 +66,6 @@
},
"devDependencies": {
"@rollup/plugin-replace": "^5.0.3",
"@tooling/eslint-config": "workspace:*",
"@tooling/tsconfig": "workspace:*",
"@types/d3-drag": "^3.0.7",
"@types/d3-interpolate": "^3.0.4",
"@types/d3-selection": "^3.0.11",
@@ -92,6 +77,19 @@
"postcss-cli": "^10.1.0",
"postcss-nested": "^6.0.1",
"vite": "^4.4.11",
"vue-tsc": "^1.8.16"
"vue-tsc": "^1.8.16",
"@tooling/tsconfig": "0.0.0",
"@tooling/eslint-config": "0.0.0"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build && vite build -c vite.config.iife.ts",
"build:watch": "vite build --watch & vite build -c vite.config.iife.ts --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && tsc -p ./tsconfig.build.json && shx rm -rf tmp && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch & tsc -p ./tsconfig.build.json --watch",
"theme": "postcss src/style.css -o dist/style.css && postcss src/theme-default.css -o dist/theme-default.css",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
}
}
}

20
packages/minimap/LICENSE Normal file
View File

@@ -0,0 +1,20 @@
Copyright (c) 2019-2025 webkid GmbH
Copyright (c) 2021-2025 Burak Cakmakoglu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

32
packages/minimap/package.json
View File

@@ -46,16 +46,6 @@
"*.d.ts"
],
"sideEffects": false,
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
"build:watch": "vite build --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
},
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
@@ -65,16 +55,26 @@
"d3-zoom": "^3.0.0"
},
"devDependencies": {
"@tooling/eslint-config": "workspace:*",
"@tooling/tsconfig": "workspace:*",
"@tooling/vite-config": "workspace:*",
"@types/d3-selection": "^3.0.7",
"@types/d3-zoom": "^3.0.5",
"@vue-flow/core": "workspace:*",
"vue-tsc": "^1.8.16"
"vue-tsc": "^1.8.16",
"@tooling/eslint-config": "0.0.0",
"@tooling/tsconfig": "0.0.0",
"@vue-flow/core": "1.46.0",
"@tooling/vite-config": "0.0.0"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
"build:watch": "vite build --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
}
}
}

20
packages/node-resizer/LICENSE Normal file
View File

@@ -0,0 +1,20 @@
Copyright (c) 2019-2025 webkid GmbH
Copyright (c) 2021-2025 Burak Cakmakoglu
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

34
packages/node-resizer/package.json
View File

@@ -1,6 +1,6 @@
{
"name": "@vue-flow/node-resizer",
"version": "1.5.1",
"version": "1.5.0",
"private": false,
"license": "MIT",
"author": "Burak Cakmakoglu<78412429+bcakmakoglu@users.noreply.github.com>",
@@ -48,16 +48,6 @@
"sideEffects": [
"*.css"
],
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
"build:watch": "vite build --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
},
"peerDependencies": {
"@vue-flow/core": "^1.23.0",
"vue": "^3.3.0"
@@ -67,16 +57,26 @@
"d3-selection": "^3.0.0"
},
"devDependencies": {
"@tooling/eslint-config": "workspace:*",
"@tooling/tsconfig": "workspace:*",
"@tooling/vite-config": "workspace:*",
"@types/d3-drag": "^3.0.4",
"@types/d3-selection": "^3.0.7",
"@vue-flow/core": "workspace:*",
"vue-tsc": "^1.8.16"
"vue-tsc": "^1.8.16",
"@tooling/eslint-config": "0.0.0",
"@tooling/tsconfig": "0.0.0",
"@tooling/vite-config": "0.0.0",
"@vue-flow/core": "1.45.0"
},
"publishConfig": {
"access": "public",
"registry": "https://registry.npmjs.org/"
},
"scripts": {
"dev": "pnpm types:watch & pnpm build:watch",
"build": "vite build",
"build:watch": "vite build --watch",
"types": "vue-tsc --declaration --emitDeclarationOnly && pnpm lint:dist",
"types:watch": "vue-tsc --declaration --emitDeclarationOnly --watch",
"lint": "eslint --ext .js,.ts,.vue ./",
"lint:dist": "eslint --ext \".ts,.tsx\" -c .eslintrc.js --fix --ignore-pattern !**/* ./dist",
"test": "exit 0"
}
}
}

12744
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff