Skip to main content

InspectorComponentProps

Props for the InspectorComponent

Properties​

afterUpdate()?​

optional afterUpdate: (s) => void

Optional function to invoke after an update.

Parameters​

s​

BrowserUI

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

multipleSelections?​

optional multipleSelections: boolean

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

refresh()?​

optional refresh: (obj) => void

Callback invoked when a new object has started to be edited. You need to provide this if the child content you provide to the Inspector is not a function.

Parameters​

obj​

Base

Returns​

void

renderEmptyContent()?​

optional renderEmptyContent: () => any

Optional function that returns JSX to use when nothing is selected

Returns​

any

showCloseButton?​

optional showCloseButton: boolean

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

surface?​

optional surface: Surface

Surface to attach to. It is not mandatory that you supply this - the component is context aware and can try to resolve a surface from an ancestor SurfaceProvider SurfaceComponent or PaperComponent.