MultiSelect

The MultiSelect component is a form component that lets users pick several options from a scrollable list.

Import

React

// with @dhl-official/react-library:
import { DhlMultiSelect } from "@dhl-official/react-library"

// with @dhl-official/ui-libraries/react-library:
import { DhlMultiSelect } from "@dhl-official/ui-libraries/react-library"

Angular

If the DUIL has been installed, you can use the web component directly:

<dhl-multi-select></dhl-multi-select>

Vue.js

If the DUIL has been installed, you can use the web component directly:

<dhl-multi-select></dhl-multi-select>

By default, menu list opens below the input. If there isn't enough space left in the viewport, it automatically opens above the input instead — no configuration required.

Code

React

<DhlMultiSelect options={options}></DhlMultiSelect>

Angular

<duil301-dhl-multi-select [options]="options" ></duil301-dhl-multi-select>

Vue.js

<duil301-dhl-multi-select :options.prop="options" ></duil301-dhl-multi-select>

The options property should be passed to the component as an array; objects within this array accept 4 values, label, value, image and disabled. The label and value properties are required. However, image and disabled are optional. Any other values that are added to this object will be ignored by default, however they can be taken into consideration when using them with custom props such as the customFilter. The select option type definition is as follows:

type DhlMultiSelectOptionType = {
  label: string;
  value: string;
  image?: string;
  disabled?: boolean;
}

Interactive Demo

Readme

Properties

Property	Attribute	Description	Type	Default
allowCustomOptionsCreation	allow-custom-options-creation	An optional prop to custom values creation.	boolean	false
changeEvent	change-event	[DEPRECATED] Use dhlChange event instead An optional input onChange callback handler.	(value: string) => boolean	undefined
chipsVariant	chips-variant	An optional prop to set component chips design variant.	"inline" | "inner" | "outer"	DHL_MULTI_SELECT.CHIPS_VARIANT.INNER
customFilter	custom-filter	An optional callback handler that accepts the options and input data, used for custom filtering. If this function is not passed, by default, filtering will happen on the "label" key of the item if it's an object or the actual value if the item is a primitive data type	(options: unknown, value: string) => DhlSelectionOptionType[]	undefined
dataAriaDescribedby	data-aria-describedby	An optional prop defining the list of reference IDs (separated by spaces), recommended when you want to an error message on your field.	string	undefined
dataAriaExpanded	data-aria-expanded	An optional prop used for assistive technology support - used to mark expandable and collapsible regions.	string	undefined
dataId	data-id	An optional prop. Gives a valid HTML ID attribute value for the component.	string	undefined
dataMaskPii	data-mask-pii	An optional prop to mask sensitive data in session-replay tools. When true, sets data-di-mask on the inner element.	boolean	undefined
dataTestid	data-testid	An optional prop. The test id attached to the component as a data-testid attribute.	string	undefined
getItemLabel	get-item-label	An optional prop used to read the label of an option.	(option: any) => void	undefined
handleCustomOptionCreate	handle-custom-option-create	An optional callback handler for custom option creation. Only works if allowCustomOptionsCreation is set to true.	(option: DhlSelectionOptionType) => void	undefined
isDisabled	is-disabled	An optional flag to define if the component is disabled.	boolean	false
menuListPosition	menu-list-position	An optional prop controlling the menu list position. auto (the default) chooses above or below based on available viewport space; below and above keep the list fixed in the selected position.	"above" | "auto" | "below"	MENU_LIST_POSITION.AUTO
name	name	An optional value to be set to the element HTML name attribute. It takes any valid value that can be used for the name attribute of an HTMLInputElement.	string	undefined
openOnFocus	open-on-focus	An optional prop when set to true, the select option list will be shown on input focus.	boolean	false
optionClickEvent	option-click-event	[DEPRECATED] Use dhlClickOption event instead An optional callback for option click event, option is passed as callback parameter.	(option: DhlSelectionOptionType) => void	undefined
options	options	An optional data prop to pass the list of options to be rendered.	DhlSelectionOptionType[]	[]
readonly	readonly	An optional flag to define if the component is readonly.	boolean	false
required	required	An optional prop to flag the component as required within a form context.	boolean	undefined
rightIcon	right-icon	An optional prop to define right icon.	string	undefined
showChipsCount	show-chips-count	An optional prop to set multi select chips counter.	boolean	true
showClearButton	show-clear-button	An optional prop flag to define if clear button is displayed.	boolean	false
showRightIcon	show-right-icon	An optional prop flag to define if right icon is displayed.	boolean	false
validation	validation	An optional object to set-up a custom components validation state. Required Fields: type	{ type: "warning" | "valid" | "invalid" | "note"; message?: string; }	undefined
value	value	An optional prop defining the value of the component which is taken when a form is submitted. Prop can accept a string or an array of strings ( options label keys ).	string | string[]	""
variant	variant	A optional object to set-up a custom components variant state. It can be used to set a custom label, a custom placeholder text, enable or disable label animation (via the mandatory type field).	{ label: string; placeholder?: string; }	undefined

Dependencies

Depends on

• duil301-dhl-select

Graph

---

Built by DHL User Interface Library Team!