diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index beb24d6c..a6710280 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,20 @@ # Contributing to React Flow -Hello there! So glad you want to help out with React Flow 🤗 You’re the best. Here’s a guide for how you can contribute to the project. +Hello there! So glad you want to help out with React Flow and Svelte Flow 🤗 You’re the best. Here’s a guide for how you can contribute to the project. + +# The new xyflow organization + +Just recently we renamed our organization and repository of React Flow to "xyflow". Now you can not only find the source code of React Flow but also of Svelte Flow in this repository. We are in a state of transition. This is the current structure: + +* React Flow `reactflow` version v11 is on branch v11 +* Svelte Flow `@xyflow/svelte` can be found under [packages/svelte](./packages/svelte) +* React Flow v12 (not published yet) can be found under [packages/react](./packages/react) # Our Contributing Philosophy -The direction of React Flow and which new features are added, and which are left out, is decided by the core team (sometimes referred to as a “cathedral” style of development). The core team is paid to do this work ([see how here](https://reactflow.dev/blog/asking-for-money-for-open-source/)). With this model we ensure that the people doing the most work on the library are paid for their time and effort, and that we prevent the library from bloating. +The direction of React Flow and Svelte Flow and which new features are added, and which are left out, is decided by the core team (sometimes referred to as a “cathedral” style of development). The core team is paid to do this work ([see how here](https://xyflow.com/blog/asking-for-money-for-open-source/)). With this model we ensure that the people doing the most work on the library are paid for their time and effort, and that we prevent the library from bloating. -That being said, React Flow is only interesting because of the people who make things with it, share their work, and discuss it. Some of the most important and undervalued work in open source is from non-code contributions, and that is where we can use the most help from you. +That being said, our libraries are only interesting because of the people who make things with it, share their work, and discuss it. Some of the most important and undervalued work in open source is from non-code contributions, and that is where we can use the most help from you. # How can I help? @@ -16,7 +24,7 @@ The things we need the most help for the library and its community are: **💬 Answering questions** in our [Discord Server](https://discord.gg/Bqt6xrs) and [Github discussions](https://github.com/wbkd/react-flow/discussions). -🎬 **Create tutorials** for React Flow. Send them to us and we’ll happily share them! +🎬 **Create tutorials**. Send them to us and we’ll happily share them! **✏️ Edit our [Docs](https://reactflow.dev/docs/introduction/)**: Make changes in the [react-flow-docs repo](https://github.com/wbkd/react-flow-docs), or click the "edit this page” button that lives on every doc site. @@ -24,7 +32,7 @@ All interactions should be done with care following our [Code of Conduct](https: ## Enhancements -If you have an idea or suggestion for an enhancement to the React Flow library, please use the [New Features](https://github.com/wbkd/react-flow/discussions/categories/new-features) discussion section. If you want to build it yourself, **please reach out to us before you dive into a new pull request.** The direction of React Flow and which new features are added are discussed in our Discord Server and in [this Github discussions section](https://github.com/wbkd/react-flow/discussions/categories/new-features), and in the end they are decided by the core team. +If you have an idea or suggestion for an enhancement to the React Flow or Svelte Flow library, please use the [New Features](https://github.com/wbkd/react-flow/discussions/categories/new-features) discussion section. If you want to build it yourself, **please reach out to us before you dive into a new pull request.** The direction of React Flow/ Svelte Flow and which new features are added are discussed in our Discord Server and in [this Github discussions section](https://github.com/wbkd/react-flow/discussions/categories/new-features), and in the end they are decided by the core team. Talking to us first about the enhancement you want to build will be the most likely way to get your pull request into the library (see Our Contributing Philosophy above). We would hate to see you write code you’re proud of, just to learn that we’ve already been working on the same thing, or that we feel doesn’t fit into the core library. diff --git a/README.md b/README.md index bd25d0f9..3964c22f 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,53 @@ -![readme-header-dark](https://user-images.githubusercontent.com/3797215/156384064-08a889d6-73c0-4cbf-8ff3-28dc601d1f5f.svg#gh-dark-mode-only) -![readme-header](https://user-images.githubusercontent.com/3797215/156259138-fb9f59f8-52f2-474a-b78c-6570867e4ead.svg#gh-light-mode-only) +![xyflow-readme](https://github.com/wbkd/react-flow/assets/2857535/5504f9d5-adbd-47c6-b3ce-8abccb5fb4a4)
![GitHub License MIT](https://img.shields.io/github/license/wbkd/react-flow?color=%23ff0072) -![npm downloads](https://img.shields.io/npm/dt/reactflow?color=%23FF0072&label=downloads) +![npm downloads](https://img.shields.io/npm/dt/reactflow?color=%23FF0072&label=React%20Flow%20downloads) +![npm downloads](https://img.shields.io/npm/dt/@xyflow/svelte?color=%23FF3E00&label=Svelte%20Flow%20downloads) ![GitHub Repo stars](https://img.shields.io/github/stars/wbkd/react-flow?color=%23FF0072) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/wbkd/react-flow?color=%23FF0072) -A highly customizable React component for building interactive graphs and node-based editors. - -[🚀 Getting Started](https://reactflow.dev/docs/quickstart/) | [📖 Documentation](https://reactflow.dev/docs/api/react-flow-props) | [📺 Examples](https://reactflow.dev/docs/examples/overview) | [☎️ Discord](https://discord.gg/RVmnytFmGW) | [💎 React Flow Pro](https://pro.reactflow.dev) +Powerful open source libraries for building node-based UIs with React or Svelte. Ready out-of-the-box and infinitely customizable. +[React Flow](https://reactflow.dev/) · [Svelte Flow](https://svelteflow.dev/) · [React Flow Pro](https://pro.reactflow.dev)
--- +## The xyflow mono repo + +The xyflow repository is the home of three packages: React Flow `reactflow`, Svelte Flow `@xyflow/svelte` and a shared helper library `@xyflow/system`. The package name of React Flow will change when we have a stable v12 (probably by beginning of 2024). Until then the current version (v11) of React Flow lives on the v11 branch and is still supported of course. + +* React Flow `reactflow` version v11 is on branch v11 +* Svelte Flow `@xyflow/svelte` can be found under [packages/svelte](./packages/svelte) +* React Flow v12 (not published yet) can be found under [packages/react](./packages/react) + ## Key Features - **Easy to use:** Seamless zooming and panning, single- and multi selection of graph elements and keyboard shortcuts are supported out of the box -- **Customizable:** Different [node](https://reactflow.dev/docs/api/nodes/node-types) and [edge types](https://reactflow.dev/docs/api/edges/edge-types) and support for custom nodes with multiple handles and custom edges -- **Fast rendering:** Only nodes that have changed are re-rendered and only those in the viewport are displayed -- **Hooks and Utils:** [Hooks](https://reactflow.dev/docs/api/hooks/use-react-flow) for handling nodes, edges and the viewport and graph [helper functions](https://reactflow.dev/docs/api/graph-util-functions) -- **Plugin Components:** [Background](https://reactflow.dev/docs/api/plugin-components/background), [MiniMap](https://reactflow.dev/docs/api/plugin-components/minimap) and [Controls](https://reactflow.dev/docs/api/plugin-components/controls) -- **Reliable**: Written in [Typescript](https://www.typescriptlang.org/) and tested with [cypress](https://www.cypress.io/) +- **Customizable:** Different node and edge types and support for custom nodes with multiple handles and custom edges +- **Fast rendering:** Only nodes that have changed are re-rendered +- **Hooks and Utils:** hooks for handling nodes, edges and the viewport and graph util functions +- **Plugin Components:** Background, Minimap, Controls and a Panel +- **Reliable**: Written in Typescript and tested with Cypress and Playwright -## Commercial Usage -**Are you using React Flow for a personal project?** Great! No sponsorship needed, you can support us by reporting any bugs you find, sending us screenshots of your projects, and starring us on Github 🌟 +## Getting Started -**Are you using React Flow at your organization and making money from it?** Awesome! We rely on your support to keep React Flow developed and maintained under an MIT License, just how we like it. You can do that on the [React Flow Pro website](https://pro.reactflow.dev) or through [Github Sponsors](https://github.com/sponsors/wbkd). +The best way to get started is to check out the [React Flow](https://reactflow.dev/learn) or [Svelte Flow](https://svelteflow.dev/learn) learn section. However if you want to get a sneak peek of how to install the and use the libraries you can see it here: -You can find more information in our [React Flow Pro FAQs](https://pro.reactflow.dev/info). +
+ React Flow basic usage -## Installation - -The easiest way to get the latest version of React Flow is to install it via npm, yarn or pnpm: - -```bash + ### Installation + + ```sh npm install reactflow -``` + ``` -## Quickstart - -This is only a very basic usage example of React Flow. To see everything that is possible with the library, please refer to the [website](https://reactflow.dev) for [guides](https://reactflow.dev/docs/guides/custom-nodes), [examples](https://reactflow.dev/docs/examples/overview) and the full [API reference](https://reactflow.dev/docs/api/react-flow-props). - -```jsx + ### Basic usage + ```jsx import { useCallback } from 'react'; import ReactFlow, { MiniMap, @@ -54,7 +56,7 @@ import ReactFlow, { useNodesState, useEdgesState, addEdge, -} from '@xyflow/react'; +} from 'reactflow'; import 'reactflow/dist/style.css'; @@ -88,44 +90,79 @@ function Flow() { export default Flow; ``` +
-## Development +
+ Svelte Flow basic usage -Before you can start developing please make sure that you have [pnpm](https://pnpm.io/) installed (`npm i -g pnpm`). Then install the dependencies using pnpm: `pnpm install`. + ### Installation + + ```sh +npm install @xyflow/svelte + ``` -Run `pnpm build` once and then you can use `pnpm dev` for local development. + ### Basic usage + ```svelte + -```sh -pnpm test + console.log('on node click', event)} +> + + + + ``` +
## Maintainers -React Flow is the full-time project of Moritz and Christopher of [webkid](https://webkid.io/), based in Berlin. If you need help or want to talk to us about a collaboration, reach out through our [contact form](https://pro.reactflow.dev/contact) or by joining the [React Flow Discord Server](https://discord.gg/Bqt6xrs). +React Flow and Svelte Flow are maintained by the team behind [xyflow](https://xyflow.com). If you need help or want to talk to us about a collaboration, reach out through our [contact form](https://xyflow.com/contact) or by joining our [Discord Server](https://discord.gg/Bqt6xrs). - Moritz Klack • [Twitter](https://twitter.com/moklick) • [Github](https://github.com/moklick) - Christopher Möller • [Twitter](https://twitter.com/chrtze) • [Github](https://github.com/chrtze) -Any support you provide goes directly towards the development and maintenance of React Flow, allowing us to continue to operate as an independent company, working on what we think is best for React Flow as an open-source library. - -## Community Packages - -- [useUndoable](https://github.com/xplato/useUndoable) - Hook for undo/redo functionality with an explicit React Flow example -- [react-flow-smart-edge](https://github.com/tisoap/react-flow-smart-edge) - Custom edge that doesn't intersect with nodes -- [Feliz.ReactFlow](https://github.com/tforkmann/Feliz.ReactFlow) - Feliz React Bindings for React Flow - -## Credits - -React Flow was initially developed for [datablocks](https://datablocks.pro), a graph-based editor for transforming, analyzing and visualizing data in the browser. Under the hood, React Flow depends on these great libraries: - -- [d3-zoom](https://github.com/d3/d3-zoom) - used for zoom, pan and drag interactions with the graph canvas -- [d3-drag](https://github.com/d3/d3-drag) - used for making the nodes draggable -- [zustand](https://github.com/pmndrs/zustand) - internal state management +Any support you provide goes directly towards the development and maintenance of React Flow and Svelte Flow, allowing us to continue to operate as an independent company, working on what we think is best for our open-source libraries. ## License -React Flow is [MIT licensed](https://github.com/wbkd/react-flow/blob/main/LICENSE). +React Flow and Svelte Flow are [MIT licensed](./LICENSE). diff --git a/examples/svelte/src/routes/usesvelteflow/Sidebar.svelte b/examples/svelte/src/routes/usesvelteflow/Sidebar.svelte index 5b81fa4f..a195cf1c 100644 --- a/examples/svelte/src/routes/usesvelteflow/Sidebar.svelte +++ b/examples/svelte/src/routes/usesvelteflow/Sidebar.svelte @@ -1,5 +1,5 @@