Dropdown multiselect
Present a list of options to the user to select multiple values from.
Props
name
string
Identifier for the group. Used in change events.
ariaLabel
string
Provides an accessible label when no visible label is associated.
ariaLabelledBy
string
References an external element that labels this component.
disabled
boolean
Disables the component.
Defaults to
false.
error
boolean
Shows an error state.
Defaults to
false.
filterable
boolean
Enables filtering of options by typing in the trigger.
labelFormat
GoabDropdownMultiselectLabelFormatOptions
The display label format of the closed dropdown. When 'count' the display label shows only "n items" in the label, when 'list' it shows a comma separated list of selected item labels.
Defaults to
list.
leadingIcon
GoabIconType
Icon shown to the left of the dropdown input.
maxHeight
string
Sets the maximum height of the dropdown content area.
Defaults to
276px.
placeholder
string
Text shown when nothing is selected.
showSelectAll
boolean
Shows a "Select All" checkbox at the top of the options list.
Defaults to
false.
size
GoabDropdownMultiselectSize
Sets the size variant.
Defaults to
default.
testId
string
Sets a data-testid attribute for automated testing.
value
string[]
Array of currently selected checkbox value.
width
string
Sets a fixed width for the component and popover panel.
mt, mr, mb, ml
Spacing
Apply margin to the top, right, bottom, and/or left of the component.
Events
onChange
(detail: GoabDropdownMultiselectOnChangeDetail) => void
Callback fired when the selected value change.
Dropdown Item Props
value
string
The value submitted when this item is selected.
filter
string
Text used to filter and match this item in typeahead search.
label
string
Display label for the dropdown item.
mountType
GoabDropdownItemMountType
Controls how the item is registered with the parent dropdown.
testId
string
Sets a data-testid attribute for automated testing.
