Home > @jsplumbtoolkit/browser-ui-vue3
browser-ui-vue3 package
Provides integration with Vue 3. This package has a dependency on the @jsplumbtoolkit/browser-ui package.
For a detailed discussion of this package, see https://docs.jsplumbtoolkit.com/toolkit/6.x/lib/vue3-integration.
Functions
| Function | Description |
|---|---|
| bindToDevLifecycle(event, handler) | |
| loadSurface(surfaceId, callback) | Loads the Surface with the given ID. |
| registerSurface(surfaceId, surface) | Register an externally created Surface with the Toolkit's Vue subsystem. This method lets you register a Surface that you created using vanilla JS (for instance if you dont want to render using Vue components) and then other Vue components such as a Palette or Inspector will be able to interact with it. |
Interfaces
| Interface | Description |
|---|---|
| Vue3RenderOptions |
Variables
| Variable | Description |
|---|---|
| BaseGroupComponent | Provides a mixin you should use to create a component that renders a group. See documentation for details. |
| BaseNodeComponent | Provides a mixin you should use to create a component that renders a node. See documentation for details. |
| COMPONENT_MINIVIEW | |
| COMPONENT_TOOLKIT | |
| DragDrop | Component to assist in adding drag/drop of new nodes/groups. This uses the low level DragManager under the hood - for most applications you probably want the SurfaceDrop component instead. |
| EVENT_VERTEX_UPDATED | |
| EVENT_VERTICES_RENDERED | |
| InspectorPlugin | Utilities for working with inspectors. This plugin contains a single component - jsplumb-edge-type-picker - that you can use to embed an edge type picker in your UI. |
| JsPlumbToolkitVue3Plugin | The Toolkit's Vue3 integration plugin. See documentation for details. |
| Palette | Provides a mixin you can use to create a component that controls a set of droppable nodes for a Surface. See documentation for details. |
| PROP_CLASS_NAME | |
| PROP_DATA | |
| PROP_ID | |
| PROP_RENDER_PARAMS | |
| PROP_SURFACE_ID | |
| PROP_TOOLKIT_PARAMS | |
| PROP_URL | |
| PROP_VIEW | |
| ShapeLibraryPlugin | Shape library plugin for Vue 3. See documentation for details. |
| SurfaceDrop | Component to assist in adding drag/drop of new nodes/groups. This uses the SurfaceDropManager under the hood - for most applications this will be sufficient. If you need finer-grained control, check out the DragDrop component. |
| TAG_EDGE_TYPE_PICKER | |
| TAG_SHAPE_PALETTE | |
| TAG_SHAPE |