Options
All
  • Public
  • Public/Protected
  • All
Menu

@braks/vue-flow

Vue Flow ๐ŸŒŠ

Vue flow top-language vulnerabilities GitHub code size in bytes GitHub last commit

Vue Flow: A highly customizable Vue 3 Flowchart component.

With Vue Flow, you can build your own, customized node-based applications like static diagrams or even more complex and interactive editors!

You can find a detailed explanation of how to get started in the documentation or check the examples.

Table of contents

โญ๏ธ 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

  • ๐Ÿฆพ Reliable: Fully written in TypeScript

๐Ÿ›  Setup

$ npm i @braks/vue-flow

# or
$ yarn add @braks/vue-flow

๐ŸŽฎ 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 '@braks/vue-flow'

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 "@braks/vue-flow/dist/style.css";

/* import the default theme (optional) */
@import "@braks/vue-flow/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

# start (dev)
$ yarn dev

# build dist
$ yarn 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.

๐Ÿ’ Special Thanks

This project is built with

  • React Flow

    • 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.js

    • D3 makes all the zoom and pan actions in the graph possible. Check it out to see if you can find other uses for it too!
  • VueUse

    • VueUse is a collection of helpful utilities/composables that have been battle-tested.

โญ Stargazers

Many thanks to the kind individuals who leave a star. Your support is much appreciated!

Stargazers for @braks/vue-flow

Generated using TypeDoc