Skip to main content

Interface: InstancesSearchProps

Props for InstancesSearch component.

See

InstancesSearch

Properties

PropertyTypeDescription

className?

string

Additional CSS class for the component.

minSearchTermLength?

number

Minimum number of characters in the search term to initiate the search.

Default

3

onAddElements?

(elements: Element[]) => void

Handler to call when elements are added from the results onto the canvas.

This handler is called only when elements are added by explicit "Add ..." button press and not via drag and drop.

onChangeCriteria?

(criteria: SearchCriteria) => void

Handler for the search criteria changes.

searchStore?

SearchInputStore<string>

Controlled search input state store.

If specified, renders the component in "headless" mode without a text filter input.

searchTimeout?

number | "explicit"

Debounce timeout in milliseconds after input to perform the text search.

If set to explicit, the search will require explicit Enter keypress or submit button click to initiate.

Default

"explicit"