RFC: Release 2.0.0

[bcakmakoglu]

The State of Vue Flow

Hello everyone,

The Vue Flow userbase has been steadily growing, for which I am so grateful.
Thank you for everyone supporting Vue Flow and using it in their projects! :)

With a growing userbase the demands of said users have also grown. More feature requests, more bugfixes, more documentation.
Though in the last couple of months I had less and less time to work on the project, I've been trying my best to keep up with bugfixes and adding some features.
I realize I have lacked on documentation in recent times and testing could also be vastly improved but as I mostly do the work by myself, it sometimes takes a while to get things done. I am sorry for these delays.
But I will continue working on Vue Flow and I am not planning on stopping anytime soon, so please don't worry that the project will suddenly become unmaintained and fade into obscurity!

Alright, so now that that is out of the way, what does the future of Vue Flow look like?
There will be another major release!
The release date (or even alpha/beta) release is not clear yet as I'm still sorting out what features/changes to include.
This is where your guys' opinion comes in:
In this discussion I'd like to give anyone that uses the library or wants to use it but feels like it's missing features the chance to comment what they'd like to see in the next major release.

What's changing?

Important

The proposals below are subject to change at any point.

Of course I've also prepared a list of points I am thinking of adding (like a very rough "roadmap"), but I'd like some feedback on some of these

Nodes/Edges

• All nodes and edges will be refactored to fit the @xyflow/system types and schema

Nodes

• Nodes will be kept separated between Node types and GraphNode (internal node) types
  • All internals properties will be set behind graphNode.internals, including computedPosition which will be renamed to positionAbsolute

Composables

• Providing "smaller" composables for specific uses that have a smaller surface of interaction
  • useEvents
  • useViewport
  • ... ?

• Split setup and use functions foruseVueFlow

  • Add provider component for easier setup `

• Reactive useNode and useEdge

  • Allow passing a ref for the id of an element you want to useNode and useEdge and receive a computed var for the element back

Options

• Add nodesDeletable and edgesDeletable global prop
• Replace elementsSelectable with nodesSelectable and edgesSelectable
• Rename fit-view-on-init to just fit-view
• Removing enums and using simple types, i.e. :position="Position.Left" -> position="left"
• Rename getNodes to getVisibleNodes
• Rename getEdges to getVisibleEdges

Removals

Composables

• useZoomPanHelper
  • All zoom pan functions are available from useVueFlow

Utils

• addEdge
  • use addEdges of useVueFlow instead
• updateEdge
  • use reconnectEdge of useVueFlow instead

Plugins

Warning

Plugins will not be part of the v2 release. Most of the "plugins" can be added on top of the existing feature set of VueFlow.

An in-depth explanation about plugins can be found in the PR.

Thank you

Thanks for reading up to this point and maybe even taking the time to leave a comment, it is greatly appreciated and once again: Thanks for using Vue Flow 💖

[prksean]

Great news! Thank you for putting efforts into this awesome project!

[bcakmakoglu]

Release 2.0.0 will have some substantial API changes to get more in line with ReactFlow/SvelteFlow.

A lot of the duplicated ways of doing things (passing props or passing options to useVueFlow for example) will be simplified and only one way will remain as to not cause too much confusion and introduce unnecessary bugs and flows.

[bcakmakoglu]

Hey guys, I know it's been a while since the last update but VueFlow 2.0.0 is still coming!

I just want to make sure that it's clear that VueFlow will not be deprecated and I won't be stopping development anytime soon even though it has slowed down significantly in recent times (I gotta work a 9-5 as well, this isn't paying any bills sadly 🤣).

The current status is that I am waiting for ReactFlow v12 to drop, which exposes a lot of functionality from a shared package which will be integrated to VueFlow, similar to SvelteFlow that is also supported by the xyflow team now 😄

Once the stable v12 release has been done, works on VueFlow 2 will start and i hope it won't disappoint!
As I said previously, there's going to be substantial, nay, monumental changes to the library with the next major release.
A migration guide will of course be provided so you can hopefully transition as smoothly as possible.

Anyway, thanks for sticking around and supporting this project ❤️

[bcakmakoglu]

Work on v2 has finally begun (anew) now that ReactFlow v12 is released.

You can track the current progress in the v2 Release PR.

I will try to keep the PR updated with whatever changes have already been made and update the opening post on this discussion to include as much info on changes as possible.