MultiSelect

MultiSelect is used to select multiple items from a collection.

Import#


import { MultiSelect } from 'primereact/multiselect';

Basic#

MultiSelect is used as a controlled component with value and onChange properties along with the options collection. There are two alternatives of how to define the options property; One way is providing a collection of SelectIteminstances having label-value pairs whereas other way is providing an array of arbitrary objects along with the optionLabel and optionValue properties to specify the label/value field pair. In addition, options can be simple primitive values such as a string array, in this case no optionLabel or optionValue is necessary.

Select a City


<MultiSelect value={selectedCities1} options={cities} onChange={(e) => setSelectedCities1(e.value)} optionLabel="name" placeholder="Select a City" maxSelectedLabels={3} />

Chips#

Used mode to display the selected items as chips.

Select a City


<MultiSelect value={selectedCities} options={cities} onChange={(e) => setSelectedCities(e.value)} optionLabel="name" placeholder="Select a City" display="chip" />

Float Label#

A floating label is implemented by wrapping the input and the label inside a container having .p-float-label style class.

empty

Select a City


<span className="p-float-label">
    <MultiSelect inputId="multiselect" value={selectedCities} options={cities} onChange={(e) => setSelectedCities(e.value)} optionLabel="name" maxSelectedLabels={3} />
    <label htmlFor="multiselect">Select a City</label>
</span>

Invalid#

Applying p-invalid class to an input element indicates a failed validation.

empty


<MultiSelect className="p-invalid" value={selectedCities1} options={cities} onChange={(e) => setSelectedCities1(e.value)} optionLabel="name" maxSelectedLabels={3} />

Disabled#

disabled prop prevents an input from being editable.

Select a City


<MultiSelect disabled placeholder="Select a City" />

Grouped#

Used mode to display the selected items as chips.

Select Cities


<MultiSelect value={selectedGroupedCities} options={groupedCities} onChange={(e) => setSelectedGroupedCities(e.value)} optionLabel="label" optionGroupLabel="label" optionGroupChildren="items" 
optionGroupTemplate={groupedItemTemplate} placeholder="Select Cities" />

Template#

Template of the panel header.

Select Countries


<MultiSelect value={selectedCountries} options={countries} onChange={(e) => setSelectedCountries(e.value)} optionLabel="name" placeholder="Select Countries" className="multiselect-custom" itemTemplate={countryTemplate} selectedItemTemplate={selectedCountriesTemplate} panelFooterTemplate={panelFooterTemplate} />

Filter#

Select a City


<MultiSelect filter value={selectedCities1} options={cities} onChange={(e) => setSelectedCities1(e.value)} optionLabel="name" placeholder="Select a City" maxSelectedLabels={3} />

Virtual Scroll (100K Items)#

Section Content

Eager#

Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.

Select Item


<MultiSelect value={selectedItems} options={items} onChange={(e) => {setSelectedItems(e.value); setSelectAll(e.value.length === items.length)}} selectAll={selectAll} onSelectAll={(e) => {setSelectedItems(e.checked ? [] : items.map(item => item.value)); setSelectAll(!e.checked)}} virtualScrollerOptions={{ itemSize: 43 }} maxSelectedLabels={3} placeholder="Select Item"/>

Lazy#

Whether to use the virtualScroller feature. The properties of VirtualScroller component can be used like an object in it.

Select Item


<MultiSelect value={selectedItems} options={lazyItems} onChange={(e) => setSelectedItems(e.value)} virtualScrollerOptions={{ lazy: true, onLazyLoad: onLazyLoad, itemSize: 43, showLoader: true, loading: lazyLoading, delay: 250, loadingTemplate: (options) => {
    return (
        <div className="flex align-items-center p-2" style={{ height: '43px' }}>
            <Skeleton width={options.even ? '70%' : '60%'} height="1.5rem" />
        </div>
    )}
}} maxSelectedLabels={3} placeholder="Select Item" showSelectAll={false}/>

Form#

Compatibility with popular React form libraries.

Formik#

Formik is a popular library for handling forms in React.


<Toast ref={toast} />
<MultiSelect id="item" name="item" options={cities} value={formik.values.item} onChange={(e) => { formik.setFieldValue('item', e.value) }} optionLabel="name" placeholder="Select a City" maxSelectedLabels={3} />
<Button type="submit" label="Submit" className="mt-2" />

Hook Form#


<Toast ref={toast} />
<Controller
    name="value"
    control={control}
    rules={{ required: 'Value is required.' }}
    render={({ field }) => <MultiSelect id={field.name} name="value" value={field.value} options={cities} onChange={(e) => field.onChange(e.value)} optionLabel="name" placeholder="Select a City" maxSelectedLabels={3} />}
/>
<Button type="submit" label="Submit" className="mt-2" />

Style#

Following is the list of structural style classes, for theming classes visit theming page.

Name	Element
p-multiselect	Container element.
p-multiselect-label-container	Container of the label to display selected items.
p-multiselect-label-container	Label to display selected items.
p-multiselect-trigger	Dropdown button.
p-multiselect-filter-container	Container of filter input.
p-multiselect-panel	Overlay panel for items.
p-multiselect-items	List container of items.
p-multiselect-item	An item in the list.
p-multiselect-token	A selected item element container on display='chip' mode.
p-chips-token-icon	Icon of a selected item element on display='chip' mode.
p-chips-token-label	Label of a selected item element on display='chip' mode.

Accessibility guide documents the specification of this component based on WCAG guidelines, the implementation is in progress.

Accessibility#

Screen Reader

Value to describe the component can either be provided with aria-labelledby or aria-label props. The multiselect component has a combobox role in addition to aria-haspopup and aria-expanded attributes. The relation between the combobox and the popup is created with aria-controls attribute that refers to the id of the popup listbox.

The popup listbox uses listbox as the role with aria-multiselectable enabled. Each list item has an option role along with aria-label, aria-selected and aria-disabled attributes.

Checkbox component at the header uses a hidden native checkbox element internally that is only visible to screen readers. Value to read is defined with the selectAll and unselectAll keys of the aria property from the locale API.

If filtering is enabled, filterInputProps can be defined to give aria-* props to the input element.

Close button uses close key of the aria property from the locale API as the aria-label by default, this can be overriden with the closeButtonProps.


<span id="dd1">Options</span>
<MultiSelect aria-labelledby="dd1" />

<MultiSelect aria-label="Options" />

Closed State Keyboard Support

Key	Function
tab	Moves focus to the multiselect element.
space	Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.
down arrow	Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.
up arrow	Opens the popup and moves visual focus to the selected option, if there is none then first option receives the focus.

Popup Keyboard Support

Key	Function
tab	Moves focus to the next focusable element in the popup, if there is none then first focusable element receives the focus.
shift + tab	Moves focus to the previous focusable element in the popup, if there is none then last focusable element receives the focus.
enter	Toggles the selection state of the focused option.
space	Toggles the selection state of the focused option.
escape	Closes the popup, moves focus to the multiselect element.
down arrow	Moves focus to the next option, if there is none then visual focus does not change.
up arrow	Moves focus to the previous option, if there is none then visual focus does not change.
home	Moves focus to the first option.
end	Moves focus to the last option.
any printable character	Moves focus to the option whose label starts with the characters being typed if dropdown is not editable.

Toggle All Checkbox Keyboard Support

Key	Function
space	Toggles the checked state.
escape	Closes the popup.

Filter Input Keyboard Support

Key	Function
enter	Closes the popup and moves focus to the multiselect element.
escape	Closes the popup and moves focus to the multiselect element.

Close Button Keyboard Support

Key	Function
enter	Closes the popup and moves focus to the multiselect element.
space	Closes the popup and moves focus to the multiselect element.
escape	Closes the popup and moves focus to the multiselect element.

API#

Visit the API documentation for detailed information about all the properties, events and methods of the component.

MultiSelect