<InspectorComponent/>

Provides an object inspector for the nodes/groups/edges in your app. When model objects are added to the model's current selection, the inspector component is informed. You can use any HTML you like in an inspector. VisuallyJs will bind values into inputs on which you have declared a vjs-att attribute, for instance:

<input vjs-att="label" type="text"></input>

Here, VisuallyJs will populate the given text input with the value of the label property in the backing data of whatever is currently selected.

If you have multiple objects selected, VisuallyJs will only populate fields of the inspector where every selected object has the same value for that field. Otherwise the field is initially left blank. Changes are, though, propagated to every selected object.

Usage

Create a Vue component that renders an InspectorComponent, and pass it a v-model that points to a ref

<script setup>
import { ref } from "vue"

const current = ref(null)
    
</script>
<template>
  <InspectorComponent v-model="current">

    <div v-if="current?.objectType==='Node'" class="node-inspector">
      <div>Text</div>
      <input type="text" vjs-att="text" vjs-focus="true"/>
      <div>Fill</div>
      <input type="color" vjs-att="fill"/>
    </div>

    <div v-if="current?.objectType==='Edge'" class="edge-inspector">
      <div>Label</div>
      <input type="text" vjs-att="label"/>
      <div>Color</div>
      <input type="color" vjs-att="color"/>
    </div>
      
    <div v-if="current == null">
        <h3>Nothing selected</h3>
    </div>  

  </InspectorComponent>
</template>
    

In our template here we examine the objectType from the selected object, which tells us whether it's a Node, Edge, Group or Port. Our UI then paints itself accordingly. At the bottom of the template we write out a message if current is null.

Data Binding

Supported elements

Elements on which the inspector will perform data binding are:

• select Drop down boxes, including those with multiple:true
• textarea For long pieces of text
• input Various input types are supported.

Supported input types

• checkbox Note: the inspector will peform a "truthy" match to determine whether or not a checkbox should be checked
• radio Note: As radio buttons are represented with strings in HTML, you can provide a vjs-datatype attribute to instruct VisuallyJs that you wish to coerce its value to a number. Read more here
• color Note: your data model must be using rgb or hex to represent colors
• number
• range
• text

Validation

As the inspector is represented using standard HTML, you can take advantage of all of the validation attributes that are available in HTML 5 elements.

Radio Button Datatypes

To tell VisuallyJs to coerce the value a given radio button represents to a number, write out a vjs-datatype attribute on it:

<input type="radio" vjs-att="foo" value="5" vjs-datatype="integer"/>

Valid values are "integer" and "float".

Setting focus

If you wish to specify a field that should receive the focus whenever the UI is updated, use vjs-focus:

<input type="text" vjs-att="label" vjs-focus="true"/>

Props

InspectorComponentProps

Props for the InspectorComponent

Name	Type	Description
afterUpdate?	(s:Surface) => void	Optional function to invoke after an update.
autoCommit?	boolean	Whether or not to auto commit on enter keypress/blur. Defaults to true.
className?	string	Optional extra css classes to set on the root element
filter?	(b:Base) => boolean	Optional filter you can use to instruct the inspector to ignore certain items.
modelValue?	Object	A model value that this component will apply 2-way binding to. You do not actually supply a prop named modelValue; you supply this as v-model="someRef".
multipleSelections?	boolean	Whether or not to support multiple selections. Defaults to true.
refresh	(obj:Base) => void	Callback invoked when a new object has started to be edited.
renderEmptyContainer	() => void	Callback invoked when the inspector is cleared.
showCloseButton?	boolean	Whether or not to show a close button. Defaults to false.
surfaceId?	string	Optional ID of the surface to attach to. It is better to nest this component inside a SurfaceComponent or SurfaceProvider.