Components/Form
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/multiselect
Multiselect allows users to enter and display multiple keyword tags.
<VariableInput/> instead.Adjust the component size using the size prop. It supports 3 sizes:
large is best for onboarding flows, where input needs emphasis.medium (default) – use for most cases.small is appropriate for dense and narrow layouts.Style the component using the border prop. It supports 4 styles:
default.round.bottomLine to create an editable, underlined title field.none.Control the component status using a status prop. It supports 3 states:
error demonstrates that a required input is missing something or the entry was invalid.warning highlights a value that might have a significant impact to a user.loading shows when a value is being uploaded to the server.Add text that explains the status or what action the user should take with the statusMessage prop.
Showing the status message inline, directly below the component is preferred in all default cases.
<FormField/> and add the statusMessage.statusMessage prop. Control tooltip placement with tooltipPlacement prop.View more inline status message examples in <FormField/>.
Multi select can also be made read-only or disabled entirely.
readOnly disables adding or editing, but allows the user to copy the current value. Use it to display URLs, code, etc.disabled removes all interactions and creates a disabled component state. Use it to highlight functions that are unavailable.Encourage user engagement by displaying the call to action. To add a <TextButton/>, use the customSuffix property.
Allow users to select only options that are listed with mode prop.
Allow users to enter their own tags using the keyboard with onManuallyInput property.
Build autocomplete features using the predicate property.
Use the onReorder property to allow users to change the order in which keywords are displayed.
Multiselect input can be useful for entering contacts or emails.
If combined with advanced list item props, multiselect can provide explicit information, therefore, making multiple keyboard entries easier.
| Name | Type | Default | Description |
|---|---|---|---|
acceptOnBlur | boolean | — | When set to true, the input is submitted as a new tag on blur. |
ariaControls | string | — | Associate a control with the regions that it controls. |
ariaDescribedby | string | — | Associate a region with its descriptions. Similar to aria-controls but instead associating descriptions to the region and description identifiers are separated with a space. |
ariaLabel | string | — | Define a string that labels the current element in case where a text label isn't visible on the screen. |
ariaRoledescription | string | — | Sets the aria-roledescription attribute of the <input> element, giving assistive technologies a readable description of its role. |
autocomplete | string | 'off' | Sets the value of the native autocomplete attribute of the input. |
autoFocus | boolean | — | Focus the element on mount (standard React input autoFocus) |
autoSelect | boolean | — | Automatically selects the entire input text. |
backgroundColor | string | — | Sets the background color of the input. Accepts any CSS color value. |
border | "none" | "standard" | "round" | "bottomLine" | — | Control the border style of input. |
children | ReactNode | — | Sets the text of the tag. |
clearButton | boolean | — | Displays clear button (X) on a non-empty input. |
clearButtonAriaLabel | string | — | Aria label for the clear button. |
clearButtonTooltipContent | ReactNode | — | When provided, hovering displays a tooltip with this content. |
clearButtonTooltipProps | TooltipCommonProps | — | Clear button tooltip props. |
clearOnBlur | boolean | true | When set to false, the input won't be cleared on blur. |
closeOnSelect | boolean | true | Closes list once list item is selected. |
customDropdownContent | ReactNode | — | Accepts any content to render in the dropdown instead of the options list. Ignored when native is true. |
customInput | ReactNode | Function | — | Render a custom input instead of the default html input tag. By default, it renders an input that sizes itself to its text. |
customPrefix | ReactNode | — | A node to display as input prefix when the dropdown is closed. |
customSuffix | ReactNode | — | A node to display as input suffix when the dropdown is closed. |
dataHook | string | — | Applies a data-hook HTML attribute that can be used in the tests. |
defaultValue | string | number | — | Defines the initial value of an input. |
delimiters | string[] | — | Delimiters that trigger a Submit action (call to onTagsAdded). By default it is [,] but also enter and tab keys work. |
disabled | boolean | — | When set to true this component is disabled. |
disableEditing | boolean | — | Restricts input editing. |
dropDirectionUp | boolean | — | Specifies whether the list opens upward. Aligns the list container to the bottom and positions the arrow for upward direction. |
dropdownOffsetLeft | string | '0' | Sets the offset of the dropdown from the left. |
dropdownWidth | string | null | Sets the width of the dropdown. |
emptyStateMessage | ReactNode | — | Defines a message to be displayed instead of options when no options exist or no options pass the predicate filter function. |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | Sets the label of the virtual keyboard's enter key on touch devices. |
fixedFooter | ReactNode | — | Adds a fixed footer container at the bottom of options list. |
fixedHeader | ReactNode | — | A fixed header to the list. |
focusOnClearClick | boolean | — | Specifies whether to focus the field when clear button is clicked. |
focusOnOption | string | number | — | Marks (not selects) and scrolls view to the option on opening the dropdown by option id. |
focusOnSelectedOption | boolean | — | Scroll view to the selected option on opening the dropdown. |
hasMore | boolean | — | Whether there are more items to be loaded. |
hideStatusSuffix | boolean | — | Specifies whether status suffix should be hidden. |
highlight | boolean | — | Mark in bold word parts based on search pattern. |
id | string | — | Assigns a unique identifier for the root element. |
inContainer | boolean | — | Whether the <DropdownLayout/> is in a container component. If true, some styles such as shadows, positioning and padding are added to the component contentContainer. |
infiniteScroll | boolean | — | Set this prop for lazy loading of the dropdown layout items. |
inputElement | ReactElement | — | Use a customized input component instead of the default |
inputmode | string | — | Sets the value of the native inputmode attribute, which tells mobile browsers which on-screen keyboard to show, for example numeric or email. |
inputRef | null | (instance: HTMLInputElement | null) => void | RefObject<HTMLInputElement> | — | Ref to the underlying <input> DOM element. Accepts callback and object refs. Use for input masking libraries such as use-mask-input. Memoize callback refs to avoid reattaching on every render. |
itemHeight | "big" | "small" | 'small' | Controls the minimum height of options that aren't builder options. |
listboxId | string | — | Defines the id for the listbox. |
listType | "select" | "action" | — | Defines type of behavior applied in list. |
loadMore | (page: number) => void | — | A callback called when more items are requested to be rendered. |
markedOption | string | number | false | true | — | Sets the default hover behavior when: 1. false means no default 2. true means to hover the first selectable option 3. Any number/string represents the id of option to hover |
max | number | — | Sets a maximum value of an input. Similar to html5 max attribute. |
maxHeightPixels | string | number | — | Set the max height of the dropdownLayout in pixels. |
maxLength | number | — | Sets the maximum number of characters that can be inserted to a field. |
maxNumRows | number | — | Max number of visible lines. |
menuArrow | boolean | — | Specifies whether input should have a dropdown menu arrow on the right side. |
min | number | — | Sets a minimum value of an input. Similar to HTML5 min attribute. |
minWidthPixels | string | number | — | Set the min width of the dropdownLayout in pixels. |
mode | "select" | — | Passing 'select' renders a readOnly input with menuArrow suffix *. |
name | string | — | Reference element data when a form is submitted. |
native | boolean | false | Indicates whether to render using the native select element. |
noLeftBorderRadius | boolean | — | Specifies whether input shouldn't have rounded corners on its left. |
noRightBorderRadius | boolean | — | Specifies whether input shouldn't have rounded corners on its right. |
onBlur | FocusEventHandler | — | Defines a standard input onBlur callback. |
onChange | ChangeEventHandler | — | Defines a standard input onChange callback. |
onClear | (event: KeyboardEvent<HTMLButtonElement> | MouseEvent<HTMLButtonElement, MouseEvent>) => void | — | Displays clear button (X) on a non-empty input and calls a callback function. |
onClickOutside | (e: MouseEvent | TouchEvent) => void | — | Defines a callback function which is called when the user clicks or touches outside the list while it's visible. |
onClose | () => void | — | Callback function called whenever the user press the Escape keyboard. |
onCompositionChange | (isComposing: boolean) => void | — | Defines a callback function called on compositionstart/compositionend events. |
onCopy | ClipboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when user copies text to a clipboard (using a mouse or keyboard shortcut) |
onDrillIn | (option: DropdownLayoutValueOption) => void | — | Called when the user presses ArrowRight on a hovered option. Use to move focus into an interactive child element (e.g. an actions menu). |
onDrillOut | () => void | — | Called when the user navigates back from a drilled-in child element (e.g. via ArrowLeft or Escape). Use to restore focus to the trigger input. |
onEnterPressed | KeyboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when the user presses -enter-. |
onEscapePressed | KeyboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when the user presses -escape-. |
onFocus | FocusEventHandler | — | Defines a standard input onFocus callback. |
onInputClicked | MouseEventHandler | — | Defines a standard input onClick callback. |
onKeyDown | KeyboardEventHandler<HTMLInputElement> | — | Defines a standard input onKeyDown callback. |
onKeyUp | KeyboardEventHandler<HTMLInputElement> | — | Defines a standard input onKeyUp callback. |
onManuallyInput | (values: string[]) => void | — | A callback which is called when the user performs a Submit-Action. Submit-Action triggers are: "Enter", "Tab", [typing any defined delimiters], Paste action. `onManuallyInput(values: Array |
onMouseDown | MouseEventHandler | — | Callback function called whenever the user clicks the dropdown layout. |
onMouseEnter | MouseEventHandler | — | Callback function called whenever the user entered with the mouse to the dropdown layout. |
onMouseLeave | MouseEventHandler | — | Callback function called whenever the user exited with the mouse from the dropdown layout. |
onOptionMarked | (option: DropdownLayoutValueOption | null, optionElementId?: string | undefined) => void | — | Callback function called whenever an option becomes focused (hovered/active). Receives the relevant option object from the original props.options array. |
onOptionsHide | () => void | — | A callback which is called when options dropdown is hidden. |
onOptionsNavigate | (option: DropdownLayoutValueOption | null) => void | — | Callback function called whenever the user navigates to an option (via keyboard or mouse). Receives the relevant option object from the original props.options array, or null when navigation is cleared. |
onOptionsShow | () => void | — | A callback which is called when options dropdown is shown. |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when user pastes text from a clipboard (using a mouse or keyboard shortcut) |
onRemoveTag | (tagId: string) => void | — | A callback function to be called when a tag should be removed. The expected callback signature is onRemoveTag(tagId: number | string) => void. |
onReorder | OnReorderFn | — | When this callback function is set, tags can be reordered. The expected callback signature is onReorder({addedIndex: number, removedIndex: number}) => void *. |
onSelect | (option: DropdownLayoutValueOption) => void | — | A callback which is called when the user selects an option from the list. onSelect(option: Option): void - Option is the original option from the provided options prop. |
options | DropdownLayoutOption[] | — | Array of objects: - id <string / number> required: the id of the option, should be unique. - value <function / string / node> required: can be a string, react element or a builder function. - disabled <bool> default value- false: whether this option is disabled or not - linkTo <string>: when provided, the option is an anchor to the given value - title <bool> default value- false deprecated: use listItemSectionBuilder to render a title instead. - overrideStyle <bool> default value- false deprecated: use overrideOptionStyle to override option styles instead. - overrideOptionStyle <bool> default value- false - when set to true, the option is responsible for its own styles. No styles are applied from the DropdownLayout itself. - label <string>: the string displayed within an input when the option is selected. This is used when using <DropdownLayout/> with an <Input/>. |
overflow | "visible" | "hidden" | "auto" | "scroll" | — | Set overflow of container. |
pattern | string | — | Sets a pattern that typed value must match to be valid (regex) |
placeholder | string | — | Sets a placeholder message to display. |
popoverProps | PopoverCommonProps | — | Accepts common popover props that are passed to the options dropdown popover. |
predicate | (option: DropdownLayoutValueOption) => boolean | — | Callback predicate for the filtering options function. |
prefix | ReactNode | — | Pass a component you want to show as the prefix of the input, e.g., text, icon. |
readOnly | boolean | — | Specifies whether input should be read only. |
required | boolean | — | Specifies whether input is mandatory. |
role | string | — | Specifies the role of the input element for accessibility. |
rtl | boolean | — | Specifies text direction. If true, the text is displayed from right to left. |
scrollbar | "fixed" | "overlay" | — | Controls which type of scrollbar to render. |
scrollToOption | string | number | — | Scrolls to the specified option when dropdown is opened without marking it. |
selectedHighlight | boolean | true | Whether the selected option is highlighted when the dropdown reopens. |
selectedId | string | number | — | The id of the selected option in the list. |
showDrawerOnMobile | boolean | true | Controls whether to show drawer on mobile devices. |
showOptionsIfEmptyInput | boolean | true | Controls whether to show options if input is empty. |
size | "small" | "tiny" | "medium" | "large" | 'medium' | Controls the size of the input and its dropdown options. tiny and small inputs render small options, the rest render medium ones. |
status | "error" | "warning" | "loading" | — | The status of the input. |
statusMessage | ReactNode | — | Text to be shown in the status icon tooltip. |
statusMessageTooltipProps | TooltipCommonProps | — | Status message tooltip props. |
step | number | — | Specifies the interval between number values. |
suffix | ReactNode | — | Pass a component you want to show as the suffix of the input, e.g., text, icon. |
tabIndex | number | — | Indicates that element can be focused and where it participates in sequential keyboard navigation. |
tags | MultiSelectTag[] | — | Optional list of strings that are selected suggestions. |
textOverflow | "ellipsis" | "clip" | — | Handles text overflow behavior. It can either clip (default) or display ellipsis. |
tooltipPlacement | "right" | "left" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-end" | "bottom-start" | "left-end" | "left-start" | — | Controls placement of a status tooltip. |
type | string | — | Specifies the type of <input/> element to display. Default is text. |
value | string | number | — | Specifies the current value of the element. |
valueParser | (option: DropdownLayoutValueOption) => ReactNode | RenderOptionFn | — | Function that receives an option, and should return the value to be displayed. |
visible | boolean | — | Should show or hide the component. |
withArrow | boolean | — | Displays an arrow on the list container while it's visible. |
withSelection | boolean | — |
No testkit for this component — it doesn't expose a unidriver testkit.
Last updated: 30 October 2026