Merge branch 'xyflow' into feat/ssr

2023-10-31 14:12:52 +01:00
parent 78169c992b 358423ebec
commit 3b781a299b
10 changed files with 300 additions and 77 deletions
@@ -1,6 +1,24 @@
-# Svelte Flow (alpha)
+![svelteflow](https://github.com/wbkd/react-flow/assets/2857535/1c722629-7e8b-4322-bfd2-aec041d64aab)

-Svelte Flow is a highly customizable component for building interactive graphs and node-based editors, built by the creators of React Flow. **This package is currently under heavy development and the API is very likely to change.**
+<div align="center">
+
+![GitHub License MIT](https://img.shields.io/github/license/wbkd/react-flow?color=%23ff0072)
+![npm downloads](https://img.shields.io/npm/dt/@xyflow/svelte?color=%23FF0072&label=downloads)
+
+Svelte Flow is a highly customizable component for building interactive graphs and node-based editors, built by the creators of React Flow. **Svelte Flow is still alpha and currently under heavy development. The API is relatively stable but some things might change.**
+
+[🚀 Getting Started](https://svelteflow.dev/learn) | [📖 Documentation](https://svelteflow.dev/api-reference/svelte-flow) | [📺 Examples](https://svelteflow.dev/examples/overview) | [☎️ Discord](https://discord.gg/RVmnytFmGW) 
+
+</div>
+
+## 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://svelteflow.dev/examples) and [edge types](https://svelteflow.dev/examples/edges/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](https://svelteflow.dev/api-reference/hooks) for handling nodes, edges and the viewport and graph [helper functions](https://svelteflow.dev/api-reference/utils)
+- **Plugin Components:** [Background](https://svelteflow.dev/api-reference/components/background), [MiniMap](https://svelteflow.dev/api-reference/components/minimap) and [Controls](https://svelteflow.dev/api-reference/components/controls)
+- **Reliable**: Written in [Typescript](https://www.typescriptlang.org) and tested with [Playwright](https://www.playwright.dev)

 ## Installation

@@ -10,14 +28,9 @@ The easiest way to get the latest version of Svelte Flow is to install it via np
 npm install @xyflow/svelte
 ```

-What is “xyflow”? Learn more [here](https://wbkd.notion.site/Upcoming-Changes-at-React-Flow-1a443641891a4069927c0a115e915251).
-
 ## Getting started

-We are working on a new website and everything so there are no docs for Svelte Flow yet. Everything is typed, so your IDE should help you a bit and you can also the [React Flow docs](https://reactflow.dev/docs) because the API is very similar. You can also check out the [Svelte Flow examples](https://github.com/wbkd/react-flow/tree/xyflow/packages/svelte/src/routes) in this repo.
-If you want to start right away you can check out the [Svelte Flow examples Stackblitz project](https://stackblitz.com/edit/svelte-flow-examples?file=src%2Froutes%2Foverview%2F%2Bpage.svelte). 
-
-A basic flow looks like this:
+You only need a few lines to get a fully interactive (e.g. select and drag nodes or pan and zoom) flow. If you want to learn more, please refer to the [learn section](https://svelteflow.dev/learn), the [examples](https://svelteflow.dev/examples) or the [API reference](https://svelteflow.dev/api-reference).

 ```svelte
 <script lang="ts">
@@ -34,8 +47,7 @@ A basic flow looks like this:
  // if you just want to load the basic styleds, you can import '@xyflow/svelte/dist/base.css'
  import '@xyflow/svelte/dist/style.css'
  
-  // We are using writables for the nodes and edges to sync them easily. When a user drags a node for example, Svelte Flow updates its position.
-  // This also makes it easier to update nodes in user land.
+  // We are using writables for the nodes and edges to sync them easily. When a user drags a node for example, Svelte Flow updates its position. This also makes it easier to update nodes in user land.
  const nodes = writable([
    {
      id: '1',
@@ -77,13 +89,13 @@ A basic flow looks like this:

 ## How to Contribute

-**Show us what you make:** Drop it in into our [Discord Server](https://discord.com/invite/Bqt6xrs), [tweet](https://twitter.com/reactflowdev) at us, or email us at info@reactflow.dev
+**Show us what you make:** Drop it in into our [Discord Server](https://discord.com/invite/Bqt6xrs), [tweet](https://twitter.com/reactflowdev) at us, or email us at info@xyflow.com

 **Community Participation:** Ask and answer questions in our [Discord Server](https://discord.com/invite/Bqt6xrs) or jump in on Github discussions.

 **Squash Bugs:** We can’t catch them all. Check existing issues and discussions first, then create a new issue to tell us what’s up.

-**Financial Support:** If you are an organization who wants to make sure Svelte Flow continues to be maintained, reach out to us at info@reactflow.dev
+**Financial Support:** If you are an organization who wants to make sure Svelte Flow continues to be maintained, reach out to us at info@xyflow.com

 And of course, we love Github stars ⭐

@@ -99,6 +111,16 @@ If you want to check out the current version you need to run the following comma
 You can now access the examples under http://127.0.0.1:5173


+## Maintainers
+
+Svelte Flow is 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 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

-Svelte Flow is MIT Licensed.
+Svelte Flow is [MIT licensed](../../LICENSE).
@@ -1,6 +1,7 @@
 <svelte:options immutable />

 <script lang="ts">
+  import cc from 'classcat';
  import { createEventDispatcher } from 'svelte';
  import { getMarkerId } from '@xyflow/system';

@@ -73,7 +74,7 @@
 <!-- svelte-ignore a11y-no-noninteractive-element-interactions -->
 {#if !hidden}
  <g
-    class="svelte-flow__edge {className}"
+    class={cc(['svelte-flow__edge', className])}
    class:animated
    class:selected
    data-id={id}
@@ -0,0 +1,4 @@
+export { default as BezierEdge } from './BezierEdge.svelte';
+export { default as StraightEdge } from './StraightEdge.svelte';
+export { default as SmoothStepEdge } from './SmoothStepEdge.svelte';
+export { default as StepEdge } from './StepEdge.svelte';
@@ -111,6 +111,14 @@
    };
  });

+  // Update width & height on resize
+  $: {
+    if (clientWidth !== undefined && clientHeight !== undefined) {
+      store.width.set(clientWidth);
+      store.height.set(clientHeight);
+    }
+  }
+
  // this updates the store for simple changes
  // where the prop names equals the store name
  $: {
@@ -51,6 +51,7 @@ export function useSvelteFlow(): {
  getConnectedEdges: (id: string | (Node | { id: Node['id'] })[]) => Edge[];
  getIncomers: (node: string | Node | { id: Node['id'] }) => Node[];
  getOutgoers: (node: string | Node | { id: Node['id'] }) => Node[];
+  toObject: () => { nodes: Node[]; edges: Edge[]; viewport: Viewport };
 } {
  const {
    zoomIn,
@@ -263,6 +264,19 @@ export function useSvelteFlow(): {

      return getOutgoersBase(_node, get(nodes), get(edges));
    },
+    toObject: () => {
+      return {
+        nodes: get(nodes).map((node) => ({
+          ...node,
+          // we want to make sure that changes to the nodes object that gets returned by toObject
+          // do not affect the nodes object
+          position: { ...node.position },
+          data: { ...node.data }
+        })),
+        edges: get(edges).map((edge) => ({ ...edge })),
+        viewport: { ...get(viewport) }
+      };
+    },
    viewport
  };
 }
@@ -7,6 +7,7 @@ export * from '$lib/container/Panel';
 export * from '$lib/components/SvelteFlowProvider';
 export * from '$lib/components/EdgeLabelRenderer';
 export * from '$lib/components/BaseEdge';
+export * from '$lib/components/edges';
 export * from '$lib/components/Handle';

 // plugins