Skip to components
DEVELOPER REFERENCE · v4.0.0

Listbox API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

Listbox6 props1 callbacks0 methods

Props6

Listbox props
NameTypeDescription
labelRequiredstringLabel content or accessible name for the component, as rendered by this control.
listRefOptional
Ref<HTMLDivElement> | undefinedInspect type
Reference to the list container for focus or scrolling integration.
variantOptional"default" | "plain" | undefinedOmit the inner frame when the list sits inside an editor pane.
spacingOptional"default" | "comfortable" | undefinedAdditional room around icon/description rows.
childrenRequired
ComponentChildrenInspect type
Content rendered inside the component. Supply nodes from the framework adapter you are using.
classNameOptionalstring | undefinedAdditional CSS classes applied to the component root.

Events and callbacks1

Listbox events and callbacks
NameTypeDescription
onSelectRequired
(value: string) => voidInspect type
Called when the user selects an item. The signature identifies the selected value and any additional context.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.