Dropdown component with store and id wrapper.

Parameters:
NameTypeDescription
propsobject

Component props.

Properties
NameTypeDescription
ajaxSearchboolean

Whether to use ajax search for the dropdown.

condensePillsboolean

Whether to condense pills in multi dropdown.

controlledboolean

Whether the dropdown is controlled or not.

customAttributesobject

Custom attributes for the component.

customClassesstring | Array | object

Custom classes for the component.

disabledboolean

Whether the dropdown is disabled or not.

hasSearchboolean

Whether the dropdown has search or not.

i18nobject

i18n strings.

idstring

The ID of the dropdown.

initialValuestring | number | Array | object

Initial value for the dropdown.

labelstring

The label text.

labelAttributesobject

Custom attributes for the label.

labelClassesstring | Array | object

Custom classes for the label.

listAttributesobject

Custom attributes for the list.

listClassesstring | Array | object

Custom classes for the list.

listItemsArray

The list items for the dropdown.

multiboolean

Whether the dropdown is a multi dropdown or not.

onAfterClosefunction

Callback for after the dropdown closes.

onAfterOpenfunction

Callback for after the dropdown opens.

onChangefunction

Callback for when the dropdown changes.

onClosefunction

Callback for when the dropdown closes.

onOpenfunction

Callback for when the dropdown opens.

onSearchfunction

Callback for when the search value changes.

popoverAttributesobject

Custom attributes for the popover.

popoverClassesstring | Array | object

Custom classes for the popover.

popoverMaxHeightnumber

The maximum height of the popover.

popoverPositionstring

The position of the popover.

searchAttributesobject

Custom attributes for the search.

searchClassesstring | Array | object

Custom classes for the search.

searchIsLoadingboolean

Whether the dropdown list items are loading from search or not.

selectedIconstring

The icon for the selected state in multi dropdown.

selectedIconPrefixstring

The prefix for the icon library to be used in multi dropdown.

simplebarboolean

Whether to use simplebar for the dropdown.

sizestring

The size of the dropdown, one of r, l, xl.

spacingstring | number | Array | object

The spacing for the component, as a string, number, array, or object.

triggerAttributesobject

Custom attributes for the trigger.

triggerClassesstring | Array | object

Custom classes for the trigger.

valuestring | number | Array | object

The value of the dropdown. Only works in controlled mode.

widthnumber

The width of the dropdown.

reffunction

The ref to the dropdown component.

Since
  • 4.5.0
Returns:

The dropdown component.

Type: 
JSX.Element