Skip to main content

InspectorComponentProps

Props for the InspectorComponent

Properties​

afterUpdate()?​

optional afterUpdate: (s) => void

Optional function to invoke after an update.

Parameters​

s​

Surface

Returns​

void

autoCommit?​

optional autoCommit: boolean

Whether or not to auto commit on enter keypress/blur. Defaults to true.

className?​

optional className: string

Optional extra css classes to set on the root element

filter()?​

optional filter: (b) => boolean

Optional filter you can use to instruct the inspector to ignore certain items.

Parameters​

b​

Base

The object to test

Returns​

boolean

modelValue?​

optional 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".

Since​

1.2.0

multipleSelections?​

optional multipleSelections: boolean

Whether or not to support multiple selections. Defaults to true.

refresh()​

refresh: (obj) => void

Callback invoked when a new object has started to be edited.

Parameters​

obj​

Base

Returns​

void

Deprecated​

Use v-model approach instead

renderEmptyContainer()​

renderEmptyContainer: () => void

Callback invoked when the inspector is cleared.

Returns​

void

Deprecated​

Use v-model approach instead

showCloseButton?​

optional showCloseButton: boolean

Whether or not to show a close button. Defaults to false.

surfaceId?​

optional surfaceId: string

Optional ID of the surface to attach to. It is better to nest this component inside a SurfaceComponent or SurfaceProvider.