Home > @jsplumbtoolkit/browser-ui-vue2
browser-ui-vue2 package
Provides integration with Vue 2. This package has a dependency on @jsplumbtoolkit/browser-ui.
For a detailed discussion of this package, see https://docs.jsplumbtoolkit.com/toolkit/6.x/lib/vue2-integration.
Functions
| Function | Description |
|---|---|
| addMiniview(surfaceId, params) | Add a Miniview to the Surface with the given id. If the Surface already exists and has been initialised the Miniview will be added immediately; otherwise it will be enqueued for later processing. This method is not typically something a user of the Toolkit will need to call, as the Miniview component does this internally. But if you find that you want to register a miniview programmatically after your UI has been initialized, this method is what you need. |
| addPalette(surfaceId, params) | Add a Palette to the Surface with the given id. If the Surface already exists and has been initialised the Palette will be added immediately; otherwise it will be enqueued for later processing. This method is not typically something a user of the Toolkit will need to call, as the Palette component does this internally. But if you find that you want to register a palette programmatically after your UI has been initialized, this method is what you need. |
| 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 |
|---|---|
| Vue2RenderOptions |
Variables
| Variable | Description |
|---|---|
| BaseGroupComponent | Provides a mixin you should use to create a component that renders a group. See documentation for usage details. |
| BaseNodeComponent | Provides a mixin you should use to create a component that renders a node. See documentation for usage details. |
| 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. |
| InspectorPlugin | |
| JsPlumbToolkitVue2Plugin | The Toolkit's Vue2 integration plugin. See documentation for usage 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 usage details. |
| ShapeLibraryPlugin | Shape library plugin for Vue 2. 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 |