Skip to main content

InspectorComponentProps

Extends​

  • DOMAttributes<HTMLDivElement>

Properties​

autoCommit?​

optional autoCommit: boolean

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

className?​

optional className: string

Optional class name to set on the component's root element.

current?​

optional current: Base | null

A $state ref that the inspector will apply 2-way binding to. Since 1.2.0 this is the preferred way to use an inspector, as it reduces the amount of boilerplate you need to configure.

Since​

1.2.0

filter()?​

optional filter: (obj) => boolean

Optional filter function that you can supply if you want to ignore certain objects in your dataset.

Parameters​

obj​

Base

Returns​

boolean

multipleSelections?​

optional multipleSelections: boolean

Whether or not to allow multiple objects to be selected and edited at once. Defaults to false.

refresh()?​

optional refresh: (obj) => void

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

Parameters​

obj​

Base

Returns​

void

Deprecated​

From 1.2.0 onwards, use the current state object approach instead.

style?​

optional style: string

Optional style to set on the component's root element.