@visuallyjs/browser-ui-svelte 1.2.5 → 1.2.7

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, type GridType, Grid, type AutoEdgeConnectOptions, CanDropOnEdgeFilter } from "@visuallyjs/browser-ui";
+import { SurfaceOptions, Vertex, Group, Node, ControlsComponentButtons, DataGeneratorFunction, Base, Size, ObjectData, PaletteMode, SvgExportUIOptions, ImageExportUIOptions, ShapeLibraryImpl, ModelOptions, DiagramOptions, Diagram, DiagramCell, NodeMapping, GroupMapping, PortMapping, BrowserUI, EdgeMapping, EdgePropertyMappings, PropertyMapping, OnVertexAddedCallback, CanvasDropFilter, FontSpec, BrowserUIModel, PreparedShape, PointXY, FixedElementConstraints, PopupPosition, OverlaySpec, PaperOptions, TilingStrategy, type GridType, Grid, type AutoEdgeConnectOptions, CanDropOnEdgeFilter, LabelPosition } from "@visuallyjs/browser-ui";
 /**
  * Render options for a SurfaceComponent. This interface is the same as SurfaceOptions but with several vanilla-only options removed.
  */
@@ -302,7 +302,7 @@ export interface PaletteComponentProps extends DOMAttributes<HTMLDivElement> {
     /**
      * Function to invoke to get a payload for an element that is being dragged/has been tapped. Defaults to a function that extracts `type` from the element via its `data-vjs-type` attribute.
      */
-    dataGenerator?: DataGeneratorFunction<BrowserElement>;
+    dataGenerator?: DataGeneratorFunction;
     /**
      * Optional function to invoke after a vertex has been added
      */
@@ -318,7 +318,7 @@ export interface PaletteComponentProps extends DOMAttributes<HTMLDivElement> {
     /**
      * Optional filter to use to decide at run time which elements may be dragged/dropped
      */
-    canvasDropFilter?: CanvasDropFilter<BrowserElement>;
+    canvasDropFilter?: CanvasDropFilter;
     /**
      * Mode to operate in - 'drag', 'tap' or 'draw'. Defaults to 'drag'.
      */
@@ -334,7 +334,7 @@ export interface PaletteComponentProps extends DOMAttributes<HTMLDivElement> {
     /**
      * Whether or not to allow drop on edge. Defaults to false.
      */
-    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter;
     /**
      * Whether or not to allow drop on whitespace in the canvas. Defaults to true.
      */
@@ -442,7 +442,7 @@ export interface ShapePaletteComponentProps extends DOMAttributes<HTMLDivElement
     /**
      * Optional data generator to allow you to specify initial data for some element to be dragged. Note that you cannot override the object's `type` with this function. The palette will set the new object's type to match the type of the element that the user is dragging from the palette.
      */
-    dataGenerator?: DataGeneratorFunction<ObjectData>;
+    dataGenerator?: DataGeneratorFunction;
     /**
      * 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.
      */
@@ -460,7 +460,7 @@ export interface ShapePaletteComponentProps extends DOMAttributes<HTMLDivElement
      * @param v
      * @param dropTarget
      */
-    onVertexAdded?: (v: Vertex, dropTarget?: DropTargetInfo) => any;
+    onVertexAdded?: OnVertexAddedCallback;
     /**
      * Mode to operate in - 'drag' or 'tap'. Defaults to 'drag' (DROP_MANAGER_MODE_DRAG).
      */
@@ -489,7 +489,7 @@ export interface ShapePaletteComponentProps extends DOMAttributes<HTMLDivElement
     /**
      * Whether or not to allow drop on edge. Defaults to false.
      */
-    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter;
     /**
      * Whether or not to allow rotation of elements being dragged. Defaults to true.
      */
@@ -527,6 +527,10 @@ export interface ShapeComponentProps extends DOMAttributes<HTMLDivElement> {
      * Stroke width to use on the text element rendering a label. Defaults to "0.25px".
      */
     labelStrokeWidth: string;
+    /**
+    * Defaults to "center". Use "top" or "bottom" to set the label above or below the shape.
+    */
+    labelPosition?: LabelPosition;
     /**
      * Optional font size/style.
      */
@@ -541,6 +545,27 @@ export interface EdgeTypePickerComponentProps extends DOMAttributes<HTMLDivEleme
      */
     propertyName: string;
 }
+/**
+ * @group Props
+ */
+export interface EdgePropertyMappingsInspectorProps extends DOMAttributes<HTMLDivElement> {
+    /**
+     * Optional, you can implement this method to return your own names to use for properties in the inspector.
+     */
+    getPropertyName?: (pm: PropertyMapping<EdgeMapping>) => string;
+    /**
+     * Optional, whether or not to show property names. Defaults to true.
+     */
+    showName?: boolean;
+    /**
+     * Optional class name to use on the wrapper div. Defaults to `vjs-inspector-section`.
+     */
+    cssClass?: string;
+    /**
+     * Optional property mappings to render a form for. The default behaviour is to retrieve the property mappings from the inspector context
+     */
+    mappings?: EdgePropertyMappings;
+}
 /**
  * @group Props
  */
@@ -813,7 +838,7 @@ export interface DiagramPaletteProps extends DOMAttributes<HTMLDivElement> {
     /**
      * Whether or not to allow drop on edge. Defaults to false.
      */
-    allowDropOnEdge?: boolean | CanDropOnEdgeFilter<any>;
+    allowDropOnEdge?: boolean | CanDropOnEdgeFilter;
     /**
      * Whether or not to allow rotation of elements being dragged. Defaults to true.
      */
@@ -895,3 +920,17 @@ export interface SurfacePopupProps {
      */
     popup: Snippet<[Vertex | null, BrowserUIModel, BrowserUI, (() => any)]>;
 }
+/**
+ * Props for ShapePropertiesInspector
+ * @group Props
+ */
+export interface ShapePropertiesInspectorProps extends DOMAttributes<HTMLDivElement> {
+    /**
+     * vertex to inspector
+     */
+    vertex: Vertex;
+    /**
+     * The maximum number of radio buttons to show for a value list before switching to a select dropdown. Defaults to 7.
+     */
+    maxRadios?: number;
+}

package/package.json

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