# 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.__

Vue Flow is a bridge to the world of interactive flowcharts and graphs, empowering you to bring
interactivity to your graphic representations. Whether it's crafting personal diagrams, generating dynamic
editors, or anything else your imagination conjures up, Vue Flow has you covered.

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 { VueFlow } from '@vue-flow/core'

const nodes = ref([
  {
    id: '1',
    label: 'node 1',
    position: {x: 100, y: 100},
  },
  {
    id: '2',
    label: 'node 2',
    position: {x: 100, y: 200},
  },
])
  
const edges = ref([
  {
    id: 'e1-2',
    target: '2',
    source: '1',
  },
])
</script>

<template>
  <VueFlow :nodes="nodes" :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 v18+](https://nodejs.org/)
- [pnpm](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)
