@visuallyjs/browser-ui-svelte 1.2.1 → 1.2.2

package/GridBackgroundComponent.svelte

@@ -0,0 +1,39 @@
+<script lang="ts">
+    import {BackgroundPlugin, GeneratedGridBackground} from "@visuallyjs/browser-ui"
+    import {useSurface} from "./use-surface.svelte";
+    import {usePaper} from "./use-paper.svelte";
+    import {type GridBackgroundComponentProps} from "./definitions";
+
+    let initialized = false
+    const surface = useSurface()
+	const paper = usePaper()
+
+    const props:GridBackgroundComponentProps = $props()
+
+	const o = props || {}
+
+	$effect(() => {
+        if (!initialized) {
+            if (surface.current) {
+                initialized = true
+                surface.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {
+                        type: GeneratedGridBackground.type,
+						...o
+                    }
+                })
+            }
+            if (paper.current) {
+                initialized = true
+                paper.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {
+                        type: GeneratedGridBackground.type,
+                        ...o
+                    }
+                })
+            }
+		}
+	})
+</script>

package/ImageBackgroundComponent.svelte

@@ -0,0 +1,37 @@
+<script lang="ts">
+    import {useSurface} from "./use-surface.svelte";
+    import { BackgroundPlugin, SimpleBackground } from "@visuallyjs/browser-ui"
+    import {usePaper} from "./use-paper.svelte";
+    import {ImageBackgroundComponentProps} from "./definitions";
+
+    let initialized = false
+    const surface = useSurface()
+	const paper = usePaper()
+
+	const { url }:ImageBackgroundComponentProps = $props()
+
+	$effect(() => {
+        if (!initialized) {
+            if (surface.current) {
+                initialized = true
+                surface.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {
+                        type: SimpleBackground.type,
+                        url
+                    }
+                })
+            }
+            if (paper.current) {
+                initialized = true
+                paper.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {
+                        type: SimpleBackground.type,
+                        url
+                    }
+                })
+            }
+		}
+	})
+</script>

package/PaperComponent.svelte

@@ -13,13 +13,13 @@
         EVENT_RENDER_END,
         CLASS_DEFAULT_GROUP,
         CLASS_DEFAULT_NODE, Paper,
-		type BrowserElement,
-		type ObjectData,
-		Vertex,
-		partition,
-		type VertexUpdatedParams,
+        type BrowserElement,
+        type ObjectData,
+        Vertex,
+        partition,
+        type VertexUpdatedParams,
         extend, EVENT_GRAPH_CLEARED, EVENT_NODE_UPDATED, EVENT_GROUP_UPDATED,
-		type NodeRemovedParams, EVENT_NODE_REMOVED,
+        type NodeRemovedParams, EVENT_NODE_REMOVED,
         type GroupRemovedParams, EVENT_GROUP_REMOVED,
         type PaperOptions,
         OVERLAY_TYPE_CUSTOM,
@@ -28,7 +28,7 @@
         type EdgeRemovedParams,
         EVENT_EDGE_UPDATED,
         EVENT_EDGE_REMOVED,
-        ELEMENT_DIV
+        ELEMENT_DIV, Edge
     } from "@visuallyjs/browser-ui";
     import { internal_getPaperContext } from "./surface-store";
 
@@ -285,6 +285,8 @@
             if (entry != null) {
                 entry.props.data = mergeData()
                 _updateVertexState()
+
+                entry.vertex.getAllEdges().forEach((edge:Edge) => updateOverlays(edge.id, {edge}))
             }
         }
 
@@ -309,7 +311,7 @@
             removeVertex(p.group.id)
         });
 
-        const updateOverlays = (edgeId: string, eventPayload: EdgeUpdatedParams) => {
+        const updateOverlays = (edgeId: string, eventPayload: { edge:Edge} ) => {
             _overlays.forEach(o => {
                 if (o.edge.id === edgeId) {
                     o.props.data = eventPayload.edge.data;

package/SurfaceComponent.svelte

@@ -13,13 +13,13 @@
         EVENT_RENDER_END,
         CLASS_DEFAULT_GROUP,
         CLASS_DEFAULT_NODE, Surface,
-		type BrowserElement,
-		type ObjectData,
-		Vertex,
-		partition,
-		type VertexUpdatedParams,
+        type BrowserElement,
+        type ObjectData,
+        Vertex,
+        partition,
+        type VertexUpdatedParams,
         extend, EVENT_GRAPH_CLEARED, EVENT_NODE_UPDATED, EVENT_GROUP_UPDATED,
-		type NodeRemovedParams, EVENT_NODE_REMOVED,
+        type NodeRemovedParams, EVENT_NODE_REMOVED,
         type GroupRemovedParams, EVENT_GROUP_REMOVED,
         type SurfaceOptions,
         OVERLAY_TYPE_CUSTOM,
@@ -28,7 +28,7 @@
         type EdgeRemovedParams,
         EVENT_EDGE_UPDATED,
         EVENT_EDGE_REMOVED,
-        ELEMENT_DIV
+        ELEMENT_DIV, Edge
     } from "@visuallyjs/browser-ui";
     import { internal_getSurfaceContext } from "./surface-store";
 
@@ -285,6 +285,8 @@
             if (entry != null) {
                 entry.props.data = mergeData()
                 _updateVertexState()
+
+				entry.vertex.getAllEdges().forEach((edge:Edge) => updateOverlays(edge.id, {edge}))
             }
         }
 
@@ -309,7 +311,7 @@
             removeVertex(p.group.id)
         });
 
-        const updateOverlays = (edgeId: string, eventPayload: EdgeUpdatedParams) => {
+        const updateOverlays = (edgeId: string, eventPayload: { edge:Edge } ) => {
             _overlays.forEach(o => {
                 if (o.edge.id === edgeId) {
                     o.props.data = eventPayload.edge.data;
@@ -334,6 +336,7 @@
             _updateOverlayState()
         })
 
+		// TODO how can this be made reactive
         if (url != null) {
             model.load({ url });
         } else if (data != null) {

package/SurfacePopup.svelte

@@ -13,20 +13,25 @@
     let container:HTMLElement
     let initialized = false
 
+	let handler:PopupHandler
     let current = $state<Vertex|null>(null)
     let display = $derived(current == null ? "none" : "block")
 
+	function hide() {
+        handler?.$hide()
+	}
+
     $effect(() => {
         if (!initialized && surface.current && container) {
             initialized = true
-            new PopupHandler(selector, container, surface.current, (v:Vertex|null) => current = v, anchor)
+            handler = new PopupHandler(selector, container, surface.current, (v:Vertex|null) => current = v, anchor)
         }
     })
 
 </script>
 
 <div bind:this={container} class={CLASS_SURFACE_POPUP} style:display={display} style:position="absolute">
-    {#if surface.current != null}
-        {@render popup(current, surface.current.model, surface.current)}
+    {#if current != null && surface.current != null}
+        {@render popup(current, surface.current.model, surface.current, hide)}
     {/if}
 </div>

package/TiledImageBackgroundComponent.svelte

@@ -0,0 +1,36 @@
+<script lang="ts">
+    import {useSurface} from "./use-surface.svelte";
+    import { BackgroundPlugin, TiledBackground } from "@visuallyjs/browser-ui"
+    import {usePaper} from "./use-paper.svelte";
+    import {TiledImageBackgroundComponentProps} from "./definitions";
+
+    let initialized = false
+    const surface = useSurface()
+	const paper = usePaper()
+
+	const props:TiledImageBackgroundComponentProps = $props()
+
+	$effect(() => {
+    	if (!initialized) {
+
+
+            if (surface.current) {
+                initialized = true
+                surface.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {type: TiledBackground.type, ...props}
+                })
+            }
+            if (paper.current) {
+                initialized = true
+                paper.current.addPlugin({
+                    type: BackgroundPlugin.type,
+                    options: {
+                        type: TiledBackground.type,
+						...props
+                    }
+                })
+            }
+		}
+	})
+</script>

package/ambient.d.ts

@@ -0,0 +1,7 @@
+declare namespace svelte.JSX {
+    interface HTMLAttributes<T> {
+        'vjs-att'?: string;
+        'vjs-port'?: string;
+        'vjs-focus'?: boolean;
+    }
+}

package/components.d.ts

@@ -31,3 +31,6 @@ export { default as OverlayWrapperComponent } from "./OverlayWrapperComponent.sv
 export { default as DiagramProvider } from "./DiagramProvider.svelte";
 export { default as SurfaceProvider } from "./SurfaceProvider.svelte";
 export { default as PaperProvider } from "./PaperProvider.svelte";
+export { default as GridBackgroundComponent } from "./GridBackgroundComponent.svelte";
+export { default as ImageBackgroundComponent } from "./ImageBackgroundComponent.svelte";
+export { default as TiledImageBackgroundComponent } from "./TiledImageBackgroundComponent.svelte";

package/components.js

@@ -31,3 +31,6 @@ export { default as OverlayWrapperComponent } from "./OverlayWrapperComponent.sv
 export { default as DiagramProvider } from "./DiagramProvider.svelte";
 export { default as SurfaceProvider } from "./SurfaceProvider.svelte";
 export { default as PaperProvider } from "./PaperProvider.svelte";
+export { default as GridBackgroundComponent } from "./GridBackgroundComponent.svelte";
+export { default as ImageBackgroundComponent } from "./ImageBackgroundComponent.svelte";
+export { default as TiledImageBackgroundComponent } from "./TiledImageBackgroundComponent.svelte";

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 } 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, GridType, Grid } from "@visuallyjs/browser-ui";
 /**
  * Render options for a SurfaceComponent. This interface is the same as SurfaceOptions but with several vanilla-only options removed.
  */
@@ -529,6 +529,128 @@ export interface ExportControlsComponentProps extends DOMAttributes<HTMLDivEleme
      */
     allowJpgExport?: boolean;
 }
+/**
+ * Props for the GridBackgroundComponent
+ * @group Props
+ */
+export interface GridBackgroundComponentProps {
+    /**
+     * The grid to use. This is optional; if you do not supply one the background will attempt to read the grid definition from the Surface. If that is also not set then a default grid of 50x50 pixels will be used.
+     */
+    grid?: Grid;
+    /**
+     * Whether or not to show a thick border around the entire background. Defaults to false.
+     */
+    showBorder?: boolean;
+    /**
+     * The minimum width for the grid. The value you provided is divided by 2 and then the grid is guaranteed to always at least span the range of (-minWidth / 2) - (minWidth / 2). Defaults to 20 000.
+     */
+    minWidth?: number;
+    /**
+     * The minimum height for the grid. The value you provided is divided by 2 and then the grid is guaranteed to always at least span the range of (-minHeight / 2) - (minHeight / 2). Defaults to 20 000.
+     */
+    minHeight?: number;
+    /**
+     * Defaults to false. If true, the grid will also draw tick marks between the grid lines.
+     */
+    showTickMarks?: boolean;
+    /**
+     * Number of tick marks to draw per cell. Defaults to 2.
+     */
+    tickMarksPerCell?: number;
+    /**
+     * The maximum width for the grid. The value you provided is divided by 2 and then the grid is guaranteed to never exceed the range of (-maxWidth / 2) - (maxWidth / 2).  maxWidth takes precedence over minWidth.
+     */
+    maxWidth?: number;
+    /**
+     * The maximum height for the grid. The value you provided is divided by 2 and then the grid is guaranteed to never exceed the range of (-maxHeight / 2) - (maxHeight / 2).  maxHeight takes precedence over minHeight.
+     */
+    maxHeight?: number;
+    /**
+     * Defaults to true, and instructs the grid that if the grid has grown beyond any minimum value set in either axis, if the content bounds subsequently shrink in that axis below the minimum, the grid should shrink back to the minimum. If you set this to false the grid will never shrink back to its minimum values once they have been exceeded.
+     */
+    autoShrink?: boolean;
+    /**
+     * Type of grid - lines or dots. Defaults to lines.
+     */
+    gridType?: GridType;
+    /**
+     * The radius for dots representing grid positions (when gridType id GridTypes.dotted). Defaults to 2.
+     */
+    dotRadius?: number;
+    /**
+     * The radius for dots representing grid tick marks (when gridType id GridTypes.dotted). Defaults to 1.
+     */
+    tickDotRadius?: number;
+    /**
+     * Whether or not the background is initially visible. Defaults to true.
+     */
+    visible?: boolean;
+}
+/**
+ * Props for the ImageBackgroundComponent
+ * @group Props
+ */
+export interface ImageBackgroundComponentProps {
+    /**
+     * URL of the image to load.
+     */
+    url: string;
+}
+/**
+ * Props for the tiled image background component
+ * @group Props
+ */
+export interface TiledImageBackgroundComponentProps {
+    /**
+     * URL for the background. You can supply this, or you can supply a `urlGenerator` function instead. If you supply `url` and no `urlGenerator`, the url you supply is treated as a template for the url for any given tile, and is expected to contain `{z}`, `{x}` and `{y}` placeholders. The form of the URL can be anything you like as long as it has the placeholders for z, x and y.  For instance:
+     *
+     * http://foo.com/{z}/{x}/{y}
+     * https://bar.com?zoom={z}&x={x}&y={y}
+     *
+     * etc
+     */
+    url?: string;
+    /**
+     * For tiled backgrounds, an optional function you can supply to generate the URL for a given tile. See `url` for
+     * an explanation of the default syntax for urls when using a tiled background.
+     * @param z zoom level
+     * @param x x coordinate of tile
+     * @param y y coordinate of tile
+     */
+    urlGenerator?: (z: number, x: number, y: number) => string;
+    /**
+     * Provides the width and height of tiles. Every tile is assumed to have these dimensions,
+     * even if the tile has whitespace in it. Required.
+     */
+    tileSize: Size;
+    /**
+     * Required. Indicates the width of the full image.
+     */
+    width: number;
+    /**
+     * Required. Indicates the height of the full image.
+     */
+    height: number;
+    /**
+     * Required. Indicates the maximum zoom level. Zoom starts at 0 - fully zoomed out - and
+     * increases in integer values from there. Each successive zoom level is twice the zoom of the previous level,
+     * meaning two times as many tiles in each direction.
+     */
+    maxZoom: number;
+    /**
+     * Default is TilingStrategies.logarithmic. See notes for `TilingStrategies` enum.
+     */
+    tiling?: TilingStrategy;
+    /**
+     * How long to wait after a pan before reloading tiles.
+     */
+    panDebounceTimeout?: number;
+    /**
+     * How long to wait after a zoom before reloading tiles.
+     */
+    zoomDebounceTimeout?: number;
+}
 /**
  * @group Props
  */
@@ -697,5 +819,5 @@ export interface SurfacePopupProps {
     /**
      * The snippet that renders the content for the popup.
      */
-    popup: Snippet<[Vertex | null, BrowserUIModel, BrowserUI]>;
+    popup: Snippet<[Vertex | null, BrowserUIModel, BrowserUI, (() => any)]>;
 }

package/index.d.ts

@@ -14,6 +14,7 @@ export * from './definitions';
 export * from './charts/definitions';
 export * from './use-zoom.svelte';
 export * from './use-surface.svelte';
+export * from './use-paper.svelte';
 export * from './use-diagram.svelte';
 export * from './use-visuallyjs-update.svelte';
 import { BrowserElement, BrowserUIModel, BrowserUIOptions, TemplateRenderer, ModelOptions } from "@visuallyjs/browser-ui";

package/index.js

@@ -14,6 +14,7 @@ export * from './definitions';
 export * from './charts/definitions';
 export * from './use-zoom.svelte';
 export * from './use-surface.svelte';
+export * from './use-paper.svelte';
 export * from './use-diagram.svelte';
 export * from './use-visuallyjs-update.svelte';
 import { BrowserUIModel, log } from "@visuallyjs/browser-ui";

package/package.json

@@ -1 +1 @@
-{"name":"@visuallyjs/browser-ui-svelte","version":"1.2.1","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"],"author":"VisuallyJs <hello@visuallyjs.com> (https://visuallyjs.com)","license":"Commercial","dependencies":{"@visuallyjs/browser-ui":"1.2.1"},"homepage":"https://visuallyjs.com/svelte","bugs":"https://github.com/visuallyjs/visuallyjs/issues"}
+{"name":"@visuallyjs/browser-ui-svelte","version":"1.2.2","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.2"},"homepage":"https://visuallyjs.com/svelte","bugs":"https://github.com/visuallyjs/visuallyjs/issues"}

package/use-diagram.svelte.d.ts

@@ -1,6 +1,6 @@
 import { Diagram } from '@visuallyjs/browser-ui';
 /**
- *
+ * Hook to access the current Diagram
  * @group Hooks
  */
 export declare function useDiagram(): {

package/use-diagram.svelte.js

@@ -1,6 +1,6 @@
 import { internal_getDiagramContext } from "./diagram-store";
 /**
- *
+ * Hook to access the current Diagram
  * @group Hooks
  */
 export function useDiagram() {

package/use-paper.svelte.d.ts

@@ -0,0 +1,7 @@
+import { Paper } from '@visuallyjs/browser-ui';
+import { RefObject } from "./definitions";
+/**
+ * Hook to access the current Paper.
+ * @group Hooks
+ */
+export declare function usePaper(): RefObject<Paper>;

package/use-paper.svelte.js

@@ -0,0 +1,18 @@
+import { internal_getPaperContext } from "./surface-store";
+/**
+ * Hook to access the current Paper.
+ * @group Hooks
+ */
+export function usePaper() {
+    const ctx = internal_getPaperContext(true);
+    let paper = $state(null);
+    if (ctx != null) {
+        ctx.listen((s) => paper = s);
+    }
+    // Return an object with a getter to maintain reactivity across function boundaries
+    return {
+        get current() {
+            return paper;
+        }
+    };
+}

package/use-surface.svelte.d.ts

@@ -1,7 +1,7 @@
 import { Surface } from '@visuallyjs/browser-ui';
 import { RefObject } from "./definitions";
 /**
- * Creates a reactive zoom state for a VisuallyJS UI
+ * Hook to access the current Surface
  * @group Hooks
  */
 export declare function useSurface(): RefObject<Surface>;

package/use-surface.svelte.js

@@ -1,6 +1,6 @@
 import { internal_getSurfaceContext } from "./surface-store";
 /**
- * Creates a reactive zoom state for a VisuallyJS UI
+ * Hook to access the current Surface
  * @group Hooks
  */
 export function useSurface() {