MultiSelect

MultiSelect is used to select multiple items from a collection.

Import #


import { MultiSelectModule } from 'primeng/multiselect';

Basic #

MultiSelect is used as a controlled component with ngModel property along with an options collection. Label and value of an option are defined with the optionLabel and optionValue properties respectively. Default property name for the optionLabel is label and value for the optionValue. If optionValue is omitted and the object has no value property, the object itself becomes the value of an option. Note that, when options are simple primitive values such as a string array, no optionLabel and optionValue would be necessary.

Select Cities


<p-multiSelect [options]="cities" [(ngModel)]="selectedCities" optionLabel="name"></p-multiSelect>

Reactive Forms #

MultiSelect can also be used with reactive forms. In this case, the formControlName property is used to bind the component to a form control.


<form [formGroup]="formGroup">
    <p-multiSelect [options]="cities" formControlName="selectedCities" optionLabel="name" placeholder="Select Cities"></p-multiSelect>
</form>

Chips #

Selected values are displayed as a comma separated list by default, setting display as chip displays them as chips.

Select Cities


<p-multiSelect [options]="cities" [(ngModel)]="selectedCities" placeholder="Select Cities" optionLabel="name" display="chip" [showClear]="true"></p-multiSelect>

Group #

Options can be grouped when a nested data structures is provided.

Select Cities


<p-multiSelect [options]="groupedCities" [group]="true" [(ngModel)]="selectedCities" placeholder="Select Cities" scrollHeight="250px" display="chip">
    <ng-template let-group pTemplate="group">
        <div class="flex align-items-center">
            <img src="https://primefaces.org/cdn/primeng/images/demo/flag/flag_placeholder.png" [class]="'mr-2 flag flag-' + group.value" style="width: 20px" />
            <span>{{ group.label }}</span>
        </div>
    </ng-template>
</p-multiSelect>

Template #

Available options and the selected options support templating with pTemplate properties respectively. In addition, header, footer and filter sections can be templated as well.

Select Countries


<p-multiSelect [options]="countries" [(ngModel)]="selectedCountries" placeholder="Select Countries" optionLabel="name">
    <ng-template let-value pTemplate="selectedItems">
        <div class="inline-flex align-items-center gap-2 px-1" *ngFor="let option of value">
            <img src="https://primefaces.org/cdn/primeng/images/demo/flag/flag_placeholder.png" [class]="'flag flag-' + option.code.toLowerCase()" style="width: 18px" />
            <div>{{ option.name }},</div>
        </div>
        <div *ngIf="!value || value.length === 0">Select Countries</div>
    </ng-template>
    <ng-template let-country pTemplate="item">
        <div class="flex align-items-center gap-2">
            <img src="https://primefaces.org/cdn/primeng/images/demo/flag/flag_placeholder.png" [class]="'flag flag-' + country.code.toLowerCase()" style="width: 18px" />
            <div>{{ country.name }}</div>
        </div>
    </ng-template>
</p-multiSelect>

Filter #

MultiSelect provides built-in filtering that is enabled by adding the filter property.

Select Cities


<p-multiSelect [options]="cities" [(ngModel)]="selectedCities" [filter]="true" optionLabel="name" placeholder="Select Cities"></p-multiSelect>

VirtualScroll #

VirtualScrolling is an efficient way of rendering the options by displaying a small subset of data in the viewport at any time. When dealing with huge number of options, it is suggested to enable VirtualScrolling to avoid performance issues. Usage is simple as setting virtualScroll property to true and defining virtualScrollItemSize to specify the height of an item.

Select Cities


<p-multiSelect
    [options]="items"
    [showToggleAll]="true"
    [selectAll]="selectAll"
    [(ngModel)]="selectedItems"
    optionLabel="label"
    [virtualScroll]="true"
    [filter]="true"
    [virtualScrollItemSize]="43"
    class="multiselect-custom-virtual-scroll"
    placeholder="Select Cities"
    (onSelectAllChange)="onSelectAllChange($event)"
    (onChange)="onChange($event)"
></p-multiSelect>

Float Label #

A floating label appears on top of the input field when focused.

empty

Select Cities


<span class="p-float-label">
    <p-multiSelect inputId="float-label" [options]="cities" [(ngModel)]="selectedCities" optionLabel="name"></p-multiSelect>
    <label for="float-label">Select Cities</label>
</span>

Invalid #

Invalid state style is added using the ng-invalid and ng-dirty class to indicate a failed validation.

Select Cities


<p-multiSelect [options]="cities" [(ngModel)]="selectedCities" class="ng-dirty ng-invalid" optionLabel="name"></p-multiSelect>

Disabled #

When disabled is present, the element cannot be edited and focused.

Select Cities


<p-multiSelect [options]="cities" [(ngModel)]="selectedCities" [disabled]="true" optionLabel="name"></p-multiSelect>

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	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-open	Container element when overlay is visible.

Accessibility #

Screen Reader

Value to describe the component can either be provided with ariaLabelledBy or ariaLabel 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>
<p-multiSelect ariaLabelledBy="dd1"></p-multiSelect>

<p-multiSelect ariaLabel="Options"></p-multiSelect>

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.

MultiSelect API

API defines helper props, events and others for the PrimeNG MultiSelect module.

MultiSelect #

MultiSelect is used to select multiple items from a collection.

Properties #

Defines the input properties of the component.

name	type	default	description
id	string	null	Unique identifier of the component
ariaLabel	string	null	Defines a string that labels the input for accessibility.
style	Object	null	Inline style of the element.
styleClass	string	null	Style class of the element.
panelStyle	any	null	Inline style of the overlay panel.
panelStyleClass	string	null	Style class of the overlay panel element.
inputId	string	null	Identifier of the focus input to match a label defined for the component.
disabled	boolean	false	When present, it specifies that the element should be disabled.
readonly	boolean	false	When present, it specifies that the component cannot be edited.
group	boolean	false	Whether to display options as grouped when nested options are provided.
filter	boolean	true	When specified, displays an input field to filter the items on keyup.
filterPlaceHolder	string	null	Defines placeholder of the filter input.
filterLocale	string	null	Locale to use in filtering. The default locale is the host environment's current locale.
overlayVisible	boolean	false	Specifies the visibility of the options panel.
tabindex	number	0	Index of the element in tabbing order.
appendTo	any	null	Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
dataKey	string	null	A property to uniquely identify a value in options.
name	string	null	Name of the input element.
ariaLabelledBy	string	null	Establishes relationships between the component and label(s) where its value should be one or more element IDs.
displaySelectedLabel	boolean	null
maxSelectedLabels	number	null
selectionLimit	number	null	Decides how many selected item labels to show at most.
selectedItemsLabel	string	{0} items selected	Label to display after exceeding max selected labels e.g. ({0} items selected), defaults "ellipsis" keyword to indicate a text-overflow.
showToggleAll	boolean	true	Whether to show the checkbox at header to toggle all items at once.
emptyFilterMessage	string	null	Text to display when filtering does not return any results.
emptyMessage	string	null	Text to display when there is no data. Defaults to global value in i18n translation configuration.
resetFilterOnHide	boolean	false	Clears the filter value when hiding the dropdown.
dropdownIcon	string	null	Icon class of the dropdown icon.
optionLabel	string	null	Name of the label field of an option.
optionValue	string	null	Name of the value field of an option.
optionDisabled	string	null	Name of the disabled field of an option.
optionGroupLabel	string	label	Name of the label field of an option group.
optionGroupChildren	string	items	Name of the options field of an option group.
showHeader	boolean	true	Whether to show the header.
filterBy	string	null	When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
scrollHeight	string	200px	Height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value.
lazy	boolean	false	Defines if data is loaded and interacted with in lazy manner.
virtualScroll	boolean	false	Whether the data should be loaded on demand during scroll.
virtualScrollItemSize	number	null	Height of an item in the list for VirtualScrolling.
virtualScrollOptions	ScrollerOptions	null	Whether to use the scroller feature. The properties of scroller component can be used like an object in it.
overlayOptions	OverlayOptions	null	Whether to use overlay API feature. The properties of overlay API can be used like an object in it.
ariaFilterLabel	string	null	Defines a string that labels the filter input.
filterMatchMode	"endsWith" \| "startsWith" \| "contains" \| "equals" \| "notEquals" \| "in" \| "lt" \| "lte" \| "gt" \| "gte"	contains	Defines how the items are filtered.
tooltip	string	null	Advisory information to display in a tooltip on hover.
tooltipPosition	"left" \| "top" \| "bottom" \| "right"	right	Position of the tooltip.
tooltipPositionStyle	string	absolute	Type of CSS position.
tooltipStyleClass	string	null	Style class of the tooltip.
autofocusFilter	boolean	true	Applies focus to the filter element when the overlay is shown.
display	string	comma	Defines how the selected items are displayed.
autocomplete	string	off	Defines the autocomplete is active.
showClear	boolean	false	When enabled, a clear icon is displayed to clear the value.
autoZIndex	boolean	null
baseZIndex	number	null
showTransitionOptions	string	null	Transition options of the show animation.
hideTransitionOptions	string	null	Transition options of the hide animation.
defaultLabel	string	null
placeholder	string	null
options	any[]	null	An array of objects to display as the available options.
filterValue	string	null	When specified, filter displays with this value.
itemSize	number	null	Item size of item to be virtual scrolled.
selectAll	boolean	null	Whether all data is selected.
focusOnHover	boolean	false	Fields used when filtering the options, defaults to optionLabel.
filterFields	any[]	null	Fields used when filtering the options, defaults to optionLabel.
selectOnFocus	boolean	false	Determines if the option will be selected on focus.
autoOptionFocus	boolean	true	Whether to focus on the first visible or selected element when the overlay panel is shown.

Emitters #

Defines emit that determine the behavior of the component based on a given condition or report the actions that the component takes.

name	parameters	description
onChange	event : MultiSelectChangeEvent	Callback to invoke when value changes.
onFilter	event : MultiSelectFilterEvent	Callback to invoke when data is filtered.
onFocus	event : MultiSelectFocusEvent	Callback to invoke when multiselect receives focus.
onBlur	event : MultiSelectBlurEvent	Callback to invoke when multiselect loses focus.
onClick	event : Event	Callback to invoke when component is clicked.
onClear	value : void	Callback to invoke when input field is cleared.
onPanelShow	value : void	Callback to invoke when overlay panel becomes visible.
onPanelHide	value : void	Callback to invoke when overlay panel becomes hidden.
onLazyLoad	event : MultiSelectLazyLoadEvent	Callback to invoke in lazy mode to load new data.
onRemove	event : MultiSelectRemoveEvent	Callback to invoke in lazy mode to load new data.
onSelectAllChange	event : MultiSelectSelectAllChangeEvent	Callback to invoke when all data is selected.

Methods #

Defines methods that can be accessed by the component's reference.

name	parameters	description
updateModel	value : any	Updates the model value.
show	isFocus : any	Displays the panel.
hide	isFocus : any	Hides the panel.

Templates #

Defines the templates used by the component.

name	parameters	description
item	context : { $implicit: any, // Data of the option. }	Custom header template.
selectedItems	context : { $implicit: any, // Selected option value. removeChip: undefined, // undefined }	Custom selected item template.
header	null	Custom header template.
filter	context : { options: MultiSelectFilterOptions, // Filter options. }	Custom filter template.
footer	null	Custom footer template.
emptyfilter	null	Custom empty filter template.
empty	null	Custom empty template.
group	context : { $implicit: any, // Data of the item. }	Custom group template.
loader	context : { options: ScrollerOptions, // Virtual scroller options. }	Custom loader template. This template can be used with virtualScroll.
dropdownicon	null	Custom dropdown trigger icon template.
clearicon	null	Custom clear icon template.
filtericon	null	Custom filter icon template.
checkicon	null	Custom check icon template.
closeicon	null	Custom close icon template.
removetokenicon	null	Custom remove token icon template.

Events #

Defines the custom events used by the component's emitters.

MultiSelectChangeEvent #

Custom change event.

name	type	description
originalEvent	Event	Browser event.
value	any	Current selected values.
itemValue	any	Toggled item value.

MultiSelectSelectAllChangeEvent #

Custom change event.

name	type	description
originalEvent	Event	Browser event.
checked	boolean	Boolean value indicates whether all data is selected.

MultiSelectFilterEvent #

Custom filter event.

name	type	description
originalEvent	Event	Browser event.
filter	any	Filter value.

MultiSelectFocusEvent #

Custom focus event.

name	type	description
originalEvent	Event	Browser event.

MultiSelectBlurEvent #

Custom blur event.

name	type	description
originalEvent	Event	Browser event.

MultiSelectLazyLoadEvent #

Custom lazy load event.

name	type	description
first	number	Index of the first element in viewport.
last	number	Index of the last element in viewport.

MultiSelectRemoveEvent #

Custom remove event.

name	type	description
newValue	object	Value after the item removed.
removed	MultiSelectItem	Removed value.

Interfaces #

Defines the custom interfaces used by the module.

MultiSelectFilterOptions #

Callbacks to invoke on filter or reset.

name	type	description
filter	Function
reset	Function