Components/Form
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/dropdown
Dropdowns let users select a single item from a predefined list of options.
<ToggleSwitch/> instead.<RadioGroup/> instead.<Autocomplete/> or <SelectorList/> instead.Adjust the component size using the size prop.
large emphasize fields in onboarding flows.medium is the default size used in most cases.small should be used in compact layouts.tiny should be used in very dense layouts. Avoid using this size when possible.Style the component using the border prop which supports four styles:
standard.round.bottomLine.none.Use the status prop to control component status.
error highlights an invalid selection.warning highlights a value that can't be validated or impacts a user's business.loading shows that the value is loading.Hide the status suffix and indicate the state with a border color by setting hideStatusSuffixto true.
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 dropdown 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/>.
Disable all input interactions with the disabled prop. Use it to highlight unavailable functions.
Add additional information to prefix and suffix props (e.g. text, icons, buttons) to support the dropdown value.
Enable a button that clears the dropdown value by using the clearButton prop. Show it when the field value is optional or has to be cleared often.
Add related actions to fixedFooter or fixedHeader areas. These headers and footers keep their position on scroll.
Use three props to build custom layouts:
listItemSectionBuilder groups items into sections by type.listItemActionBuilder adds a text button for related list actions.listItemSelectBuilder builds custom list designs.Control the container size for the list of options with these props:
maxHeightPixels specifies the maximum height for longer lists.dropdownWidth matches content width or specifies pixels. Set width to 'auto' or 'max-content.'minWidthPixels manually increases dropdown popover width.By default, the dropdown matches the input field width.
Once the dropdown is opened, use the markedOption to highlight the option.
Switch to native support for mobile usage. Avoid using it for desktop applications.
Control text overflow in the field with the textOverflow. Apply clip or ellipsis.
Dropdown list options wrap by default. To apply ellipsis, select the items to be displayed with the listItemSelectBuilder. This isn't recommended.
Gradually load items with infiniteScroll, loadMore and hasMore props.
Component can be used in controlled mode by passing selectedId and onSelect props.
Use dropdown to let users select a single item from a predefined list of options in a settings panel.
Use listItemSelectBuilder to create custom layouts for options in the dropdown. For example, use avatars, icons or images as prefix icons.
Use listItemSectionBuilder within the drop down to group options into categories.
| Name | Type | Default | Description |
|---|---|---|---|
allowTextSelection | boolean | true | Controls whether a user can select a text of a selected value. |
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 | — | |
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. |
closeOnSelect | boolean | true | Closes DropdownLayout on option selection. |
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. |
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. |
disabled | boolean | — | Specifies whether input should be disabled or not. |
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. |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | Sets the label of the virtual keyboard's enter key on touch devices. |
fixedFooter | ReactNode | — | A fixed footer to the 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. |
initialSelectedId | string | number | — | An initial selected option id. (Implies Uncontrolled mode) |
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. |
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. |
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 | ManualInputFnSignature | — | 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) |
onSelect | (option: DropdownLayoutValueOption, sameOptionWasPicked: boolean) => void | — | Defines a callback function which is called when the user selects an option from the list. When highlight is true, it receives the original option from options. |
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. |
prefix | ReactNode | — | Pass a component you want to show as the prefix of the input, e.g., text, icon. |
readOnly | boolean | — | Specifies whether input is 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 | — | Specifies selected option by its id. |
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" | — | Specify the status of a field. |
statusMessage | ReactNode | — | Defines the message to display on status icon hover. If not given or empty, no tooltip is displayed. |
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. |
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 | — |
Import the driver matching your test environment:
| Method | Description |
|---|---|
exists | — |
driver | — |
inputDriver | — |
dropdownLayoutDriver | — |
Last updated: 26 October 2026