@visuallyjs/browser-ui-svelte 1.2.3 → 1.2.5

package/DiagramPaletteComponent.svelte

@@ -1,9 +1,7 @@
 <script lang="ts">
 
 	import {type DiagramPaletteProps} from "./definitions";
-    import {Diagram, DiagramPalette, log} from "@visuallyjs/browser-ui";
-    import {internal_getDiagramContext} from "./diagram-store";
-    import {onMount} from "svelte";
+    import {DiagramPalette} from "@visuallyjs/browser-ui";
     import {useDiagram} from "./use-diagram.svelte";
 
     let initialised = false
@@ -30,7 +28,13 @@
                 autoExitDrawMode:props.autoExitDrawMode,
                 selectAfterAdd:props.selectAfterAdd,
                 onVertexAdded:props.onVertexAdded,
-                preparedShapes:props.preparedShapes
+                preparedShapes:props.preparedShapes,
+                allowDropOnEdge:props.allowDropOnEdge,
+                allowRotation:props.allowRotation,
+                rotationSpeed:props.rotationSpeed,
+                autoEdgeConnect:props.autoEdgeConnect,
+                showGroups:props.showGroups !== false,
+                updateTypeOnPaletteTap:props.updateTypeOnPaletteTap
             })
 		}
 	})

package/PaletteComponent.svelte

@@ -27,7 +27,10 @@
 		allowDropOnGroup = true,
 		allowDropOnCanvas = true,
 		allowDropOnNode = false,
-		ignoreDropOnNode = false
+		ignoreDropOnNode = false,
+		allowRotation = true,
+		rotationSpeed = 2000,
+		autoEdgeConnect = false
     }:PaletteComponentProps = $props()
 
     $effect(() => {
@@ -48,7 +51,13 @@
                 allowDropOnEdge,
                 allowDropOnCanvas,
                 allowDropOnGroup,
-                ignoreDropOnNode
+                ignoreDropOnNode,
+                allowRotation,
+                rotationSpeed,
+                autoEdgeConnect,
+                autoEdgeConnectActiveClass,
+                autoEdgeConnectMode,
+                autoEdgeLineStyle
             })
         }
 

package/PaperComponent.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-    import { onMount, type Snippet } from "svelte";
+    import { onMount, untrack, type Snippet } from "svelte";
     import {
         BrowserUISvelteModel,
         newInstance,
@@ -47,6 +47,7 @@
         model,
         data,
         url,
+        dataType,
         shapeLibrary,
         injector,
 		children
@@ -54,7 +55,7 @@
 
     const paperContext = internal_getPaperContext(false);
 
-    let paper:Paper;
+    let paper = $state<Paper>();
 
     export function getPaper() {
         return paper
@@ -200,6 +201,30 @@
         el.parentNode && el.parentNode.removeChild(el);
     }
 
+    $effect(() => {
+        if (url != null && paper != null) {
+            untrack(() => {
+                paper.model.clear();
+                requestAnimationFrame(() => {
+                    paper.model.load({ url, dataType });
+				})
+
+            });
+        }
+    });
+
+    $effect(() => {
+        if (data != null && paper != null) {
+            untrack(() => {
+                paper.model.clear();
+                requestAnimationFrame(() => {
+                    paper.model.load({ data, dataType });
+				})
+
+            });
+        }
+    });
+
     onMount(async () => {
         model = model || newInstance(modelOptions || {});
 
@@ -335,12 +360,6 @@
             _overlays = []
             _updateOverlayState()
         })
-
-        if (url != null) {
-            model.load({ url });
-        } else if (data != null) {
-            model.load({ data });
-        }
     });
 
 </script>

package/ShapePaletteComponent.svelte

@@ -22,7 +22,13 @@
 		allowClickToAdd,
 		autoExitDrawMode,
 		inspector = true,
-		preparedShapes
+		updateTypeOnPaletteTap = false,
+		preparedShapes,
+		allowDropOnEdge,
+		allowRotation = true,
+		rotationSpeed = 2000,
+		autoEdgeConnect,
+		showGroups = true
     }:ShapePaletteComponentProps = $props()
 
     let container:HTMLElement
@@ -57,8 +63,13 @@
 					fill,
 					dragSize,
 					inspector,
-					preparedShapes
-
+					updateTypeOnPaletteTap,
+					preparedShapes,
+					allowDropOnEdge,
+					allowRotation,
+					rotationSpeed,
+					autoEdgeConnect,
+					showGroups
                 })
 
 			}

package/SurfaceComponent.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-    import { onMount, type Snippet } from "svelte";
+    import {onMount, type Snippet, untrack} from "svelte";
     import {
         BrowserUISvelteModel, internal_createDiagramContext,
         newInstance,
@@ -47,6 +47,7 @@
         model,
         data,
         url,
+        dataType,
         shapeLibrary,
         injector,
 		children
@@ -54,7 +55,7 @@
 
     const surfaceContext = internal_getSurfaceContext(false);
 
-    let surface:Surface;
+    let surface = $state<Surface>();
 
     export function getSurface() {
         return surface
@@ -200,6 +201,28 @@
         el.parentNode && el.parentNode.removeChild(el);
     }
 
+    $effect(() => {
+        if (url != null && surface != null) {
+            untrack(() => {
+                surface.model.clear();
+                requestAnimationFrame(() => {
+                    surface.model.load({url, dataType});
+                })
+            });
+        }
+    });
+
+    $effect(() => {
+        if (data != null && surface != null) {
+            untrack(() => {
+                surface.model.clear();
+                requestAnimationFrame(() => {
+                    surface.model.load({data, dataType});
+                })
+            });
+        }
+    });
+
     onMount(async () => {
         model = model || newInstance(modelOptions || {});
 
@@ -328,7 +351,6 @@
         model.bind<EdgeUpdatedParams>(EVENT_EDGE_UPDATED, (p) => updateOverlays(p.edge.id, p));
         model.bind<EdgeRemovedParams>(EVENT_EDGE_REMOVED, (p) => removeOverlays(p.edge.id));
 
-
         model.bind(EVENT_GRAPH_CLEARED, () => {
             _vertices = []
             _updateVertexState()
@@ -336,12 +358,6 @@
             _updateOverlayState()
         })
 
-		// TODO how can this be made reactive
-        if (url != null) {
-            model.load({ url });
-        } else if (data != null) {
-            model.load({ data });
-        }
     });
 
 </script>

package/definitions.d.ts

@@ -1,6 +1,6 @@
 import { type Snippet } from "svelte";
 import type { DOMAttributes } from "svelte/elements";
-import { SurfaceOptions, Vertex, Group, Node, ControlsComponentButtons, DataGeneratorFunction, type BrowserElement, Base, Size, ObjectData, DropTargetInfo, PaletteMode, SvgExportUIOptions, ImageExportUIOptions, ShapeLibraryImpl, ModelOptions, DiagramOptions, Diagram, DiagramCell, NodeMapping, GroupMapping, PortMapping, BrowserUI, EdgeMapping, OnVertexAddedCallback, CanvasDropFilter, FontSpec, BrowserUIModel, PreparedShape, PointXY, FixedElementConstraints, PopupPosition, OverlaySpec, PaperOptions, TilingStrategy, GridType, Grid } from "@visuallyjs/browser-ui";
+import { SurfaceOptions, Vertex, Group, Node, ControlsComponentButtons, DataGeneratorFunction, type BrowserElement, Base, Size, ObjectData, DropTargetInfo, PaletteMode, SvgExportUIOptions, ImageExportUIOptions, ShapeLibraryImpl, ModelOptions, DiagramOptions, Diagram, DiagramCell, NodeMapping, GroupMapping, PortMapping, BrowserUI, EdgeMapping, OnVertexAddedCallback, CanvasDropFilter, FontSpec, BrowserUIModel, PreparedShape, PointXY, FixedElementConstraints, PopupPosition, OverlaySpec, PaperOptions, TilingStrategy, type GridType, Grid, type AutoEdgeConnectOptions, CanDropOnEdgeFilter } from "@visuallyjs/browser-ui";
 /**
  * Render options for a SurfaceComponent. This interface is the same as SurfaceOptions but with several vanilla-only options removed.
  */
@@ -129,6 +129,10 @@ export interface SurfaceComponentProps extends DOMAttributes<HTMLDivElement> {
      * Optional url from which to load data after the component has been mounted. If you provide this and also data, this will take precedence.
      */
     url?: string;
+    /**
+     * ID of the format that `data` or the data retrieved from `url` is expected to be in. Defaults to `JSON_DATATYPE`.
+     */
+    dataType?: string;
     /**
      * Shape library to use to render SVG shapes. Optional.
      */
@@ -179,6 +183,10 @@ export interface PaperComponentProps extends DOMAttributes<HTMLDivElement> {
      * Optional url from which to load data after the component has been mounted. If you provide this and also data, this will take precedence.
      */
     url?: string;
+    /**
+     * ID of the format that `data` or the data retrieved from `url` is expected to be in. Defaults to `JSON_DATATYPE`.
+     */
+    dataType?: string;
     /**
      * Shape library to use to render SVG shapes. Optional.
      */
@@ -326,7 +334,7 @@ export interface PaletteComponentProps extends DOMAttributes<HTMLDivElement> {
     /**
      * Whether or not to allow drop on edge. Defaults to false.
      */
-    allowDropOnEdge?: boolean;
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
     /**
      * Whether or not to allow drop on whitespace in the canvas. Defaults to true.
      */
@@ -343,6 +351,22 @@ export interface PaletteComponentProps extends DOMAttributes<HTMLDivElement> {
      * Defaults to false. When true, the palette treats nodes as if they are part of the canvas - a user can drag new items on top of existing nodes and the new item will be added to the canvas. If you want to force your users to drop on canvas whitespace, don't set this.  Note that this flag will force `allowDropOnNode` to `false`.
      */
     ignoreDropOnNode?: boolean;
+    /**
+     * Whether or not to allow rotation of elements being dragged. Defaults to true.
+     */
+    allowRotation?: boolean;
+    /**
+     * The number of milliseconds required to complete a full rotation of an element when the trigger key is held down. Defaults to 2000.
+     */
+    rotationSpeed?: number;
+    /**
+     * Controls whether the palette will automatically connect a new vertex being dragged onto the canvas to existing vertices, if the shape definitions for the new vertex and/or the existing vertices have source/target elements. You can set this to simply 'true', and use defaults, or you can provide values for various options.
+     */
+    autoEdgeConnect?: boolean | AutoEdgeConnectOptions;
+    /**
+     * Whether or not to show groups in the palette. Defaults to true.
+     */
+    showGroups?: boolean;
 }
 /**
  * @group Props
@@ -450,13 +474,38 @@ export interface ShapePaletteComponentProps extends DOMAttributes<HTMLDivElement
      */
     autoExitDrawMode?: boolean;
     /**
-     * Indicates two things: first, when one or more vertices are selected, clicking on an entry in the palette will change the type of the selected vertices to that type. Secondly, selecting an element in the canvas will cause its related shape to be selected in the palette. Defaults to true.
+     * When `true`, selecting an element in the canvas will cause its related shape to be selected in the palette. Defaults to true.
      */
     inspector?: boolean;
+    /**
+     * When `true`, clicking on an entry in the palette will change the type of any selected vertices to that type. Defaults to `false`.
+     * This is a potentially destructive operation if the properties of the new shape type are not compatible with the old one.
+     */
+    updateTypeOnPaletteTap?: boolean;
     /**
      * Optional set of prepared shapes to show in the palette. When this is provided, the palette will only render these shapes, and not the contents of the shape library.
      */
     preparedShapes?: Array<PreparedShape>;
+    /**
+     * Whether or not to allow drop on edge. Defaults to false.
+     */
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
+    /**
+     * Whether or not to allow rotation of elements being dragged. Defaults to true.
+     */
+    allowRotation?: boolean;
+    /**
+     * The number of milliseconds required to complete a full rotation of an element when the trigger key is held down. Defaults to 2000.
+     */
+    rotationSpeed?: number;
+    /**
+     * Controls whether the palette will automatically connect a new vertex being dragged onto the canvas to existing vertices, if the shape definitions for the new vertex and/or the existing vertices have source/target elements. You can set this to simply 'true', and use defaults, or you can provide values for various options.
+     */
+    autoEdgeConnect?: boolean | AutoEdgeConnectOptions;
+    /**
+     * Whether or not to show groups in the palette. Defaults to true.
+     */
+    showGroups?: boolean;
 }
 /**
  * @group Props
@@ -699,9 +748,14 @@ export interface DiagramPaletteProps extends DOMAttributes<HTMLDivElement> {
      */
     dragSize?: Size;
     /**
-     * Indicates that when one or more vertices are selected, clicking on an entry in the palette will change the type of the selected vertices to that type. Defaults to true.
+     * When `true`, selecting an element in the canvas will cause its related shape to be selected in the palette. Defaults to true.
      */
     inspector?: boolean;
+    /**
+     * When `true`, clicking on an entry in the palette will change the type of any selected vertices to that type. Defaults to `false`.
+     * This is a potentially destructive operation if the properties of the new shape type are not compatible with the old one.
+     */
+    updateTypeOnPaletteTap?: boolean;
     /**
      * Optional size to use for icons. Defaults to 150x100 pixels. If you provide this but not `dragSize` this size will also be used for an icon that is being dragged.
      */
@@ -756,6 +810,26 @@ export interface DiagramPaletteProps extends DOMAttributes<HTMLDivElement> {
      * Optional set of prepared shapes to show in the palette. When this is provided, the palette will only render these shapes, and not the contents of the shape library.
      */
     preparedShapes?: Array<PreparedShape>;
+    /**
+     * Whether or not to allow drop on edge. Defaults to false.
+     */
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
+    /**
+     * Whether or not to allow rotation of elements being dragged. Defaults to true.
+     */
+    allowRotation?: boolean;
+    /**
+     * The number of milliseconds required to complete a full rotation of an element when the trigger key is held down. Defaults to 2000.
+     */
+    rotationSpeed?: number;
+    /**
+     * Controls whether the palette will automatically connect a new vertex being dragged onto the canvas to existing vertices, if the shape definitions for the new vertex and/or the existing vertices have source/target elements. You can set this to simply 'true', and use defaults, or you can provide values for various options.
+     */
+    autoEdgeConnect?: boolean | AutoEdgeConnectOptions;
+    /**
+     * Whether or not to show groups in the palette. Defaults to true.
+     */
+    showGroups?: boolean;
 }
 /**
  * Props for the ColorPicker inspector component.

package/package.json

@@ -1 +1 @@
-{"name":"@visuallyjs/browser-ui-svelte","version":"1.2.3","description":"VisuallyJS Svelte integration for Browser UI renderer","module":"index.js","main":"index.js","types":"index.d.ts","svelte":"index.js","files":["**/*.d.ts","**/*.js","SurfaceComponent.svelte","PaperComponent.svelte","DecoratorComponent.svelte","DefaultGroupComponent.svelte","DefaultNodeComponent.svelte","MiniviewComponent.svelte","ControlsComponent.svelte","SurfaceProvider.svelte","PaperProvider.svelte","PaletteComponent.svelte","InspectorComponent.svelte","EdgeTypePickerComponent.svelte","ShapePaletteComponent.svelte","ExportControlsComponent.svelte","ShapeComponent.svelte","DiagramComponent.svelte","BarChartComponent.svelte","ColumnChartComponent.svelte","XYChartComponent.svelte","LineChartComponent.svelte","AreaChartComponent.svelte","PieChartComponent.svelte","WrapperComponent.svelte","OverlayWrapperComponent.svelte","DiagramProvider.svelte","DiagramPaletteComponent.svelte","ColorPickerComponent.svelte","ScatterChartComponent.svelte","BubbleChartComponent.svelte","GaugeChartComponent.svelte","SankeyChartComponent.svelte","SurfacePopup.svelte","GridBackgroundComponent.svelte","ImageBackgroundComponent.svelte","TiledImageBackgroundComponent.svelte"],"author":"VisuallyJs <hello@visuallyjs.com> (https://visuallyjs.com)","license":"Commercial","dependencies":{"@visuallyjs/browser-ui":"1.2.3"},"homepage":"https://visuallyjs.com/svelte","bugs":"https://github.com/visuallyjs/visuallyjs/issues"}
+{"name":"@visuallyjs/browser-ui-svelte","version":"1.2.5","description":"VisuallyJS Svelte integration for Browser UI renderer","module":"index.js","main":"index.js","types":"index.d.ts","svelte":"index.js","files":["**/*.d.ts","**/*.js","SurfaceComponent.svelte","PaperComponent.svelte","DecoratorComponent.svelte","DefaultGroupComponent.svelte","DefaultNodeComponent.svelte","MiniviewComponent.svelte","ControlsComponent.svelte","SurfaceProvider.svelte","PaperProvider.svelte","PaletteComponent.svelte","InspectorComponent.svelte","EdgeTypePickerComponent.svelte","ShapePaletteComponent.svelte","ExportControlsComponent.svelte","ShapeComponent.svelte","DiagramComponent.svelte","BarChartComponent.svelte","ColumnChartComponent.svelte","XYChartComponent.svelte","LineChartComponent.svelte","AreaChartComponent.svelte","PieChartComponent.svelte","WrapperComponent.svelte","OverlayWrapperComponent.svelte","DiagramProvider.svelte","DiagramPaletteComponent.svelte","ColorPickerComponent.svelte","ScatterChartComponent.svelte","BubbleChartComponent.svelte","GaugeChartComponent.svelte","SankeyChartComponent.svelte","SurfacePopup.svelte","GridBackgroundComponent.svelte","ImageBackgroundComponent.svelte","TiledImageBackgroundComponent.svelte"],"author":"VisuallyJs <hello@visuallyjs.com> (https://visuallyjs.com)","license":"Commercial","dependencies":{"@visuallyjs/browser-ui":"1.2.5"},"homepage":"https://visuallyjs.com/svelte","bugs":"https://github.com/visuallyjs/visuallyjs/issues"}