AddressInputItem

Components/Form/AddressInput/AddressInputItem

Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/addressinputitem

Overview

Copy

Address Input Item is an internal component that displays address list item in a dropdown selection. It's mainly used as a part of the <AddressInput/> component.

Do

  • Use it to represent address selection items.

Don't

  • Don't use it to represent an option of any select component. Use <ListItemSelect/> instead.

Feature examples

Structure

The component consists of two labels accompanied by a location icon:
 - `mainLabel` - use it to display a main keywords for search suggestions;
 - `secondaryLabel` - use it for secondary address data, such as country or region.

Copy

States

Control the state of a component with:
 - `highlighted` - use it to mark a suggested value
 - `selected` use it to mark an active selection
 - `disabled` - use it to mark an unavailable item

Copy

Layout

Control option layout with optionLayout prop. It supports 2 values:
 - `single-line` (default) - use in all common cases
 - `double-line` - use for addresses that display more data (include country, region, post code and more)

Copy

Affix

Support option value with additional information added to `prefix` and `suffix` props. Props accept text, icons and even badges.

`prefix` area by default is filled with a location icon to indicate that this is an address list item.

Copy

Common use case examples

List item builders

Use it as a list item to build custom address input suggestions.

Copy

Code

Copy

Props

NameTypeDefaultDescription
dataHookstring—Applies a data-hook HTML attribute that can be used in the tests.
disabledboolean—Specifies whether option is disabled.
highlightedboolean—Specifies whether option is highlighted.
mainLabelstring—Sets the main label of an option. This label is a primary part that is matched to a search term or keyword.
onClickMouseEventHandler—Defines a callback function which is called every time option is clicked.
optionLayout"single-line" | "double-line"'single-line'Sets the layout of mainLabel and secondaryLabel. Labels can be either side by side or stacked vertically.
prefixReactNode—Pass a component you want to show as the prefix of the input, e.g., text, icon.
secondaryLabelstring—Sets the additional information of an address. Usually contains a region or a country.
selectedboolean—Specifies whether the option is selected.
size"small" | "medium"—Controls the size of the labels. When rendered inside <AddressInput/>, it is set from the input size. Default value: medium.
suffixReactNode—Pass a component you want to show as the suffix of the input, e.g., text, icon, button.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
getPrefixGet prefix
getMainLabelTextGet main label Text
getSecondaryLabelTextGet secondary label Text
getSuffixGet suffix
existsChecks whether the component found with the given data hook.
elementGets the component root element.
clickClicks on the component root element.
baseReturns UniDriver for the base element.

Changelog

  • 1.340.0 (2026-10-21) — maintenance release, no component-specific changes
  • 1.339.0 (2026-10-19) — maintenance release, no component-specific changes
  • 1.338.0 (2026-10-15) — maintenance release, no component-specific changes
  • 1.331.0 (2026-10-01) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.329.0 (2026-09-24) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.323.0 (2026-09-10) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.291.0 (2026-06-19) — maintenance release, no component-specific changes
  • 1.266.0 (2026-04-07) — maintenance release, no component-specific changes
  • 1.260.0 (2026-03-17) — maintenance release, no component-specific changes
  • 1.254.0 (2026-02-03) — maintenance release, no component-specific changes
  • 1.242.0 (2025-12-19) — maintenance release, no component-specific changes
  • 1.187.0 (2025-05-07) — maintenance release, no component-specific changes
  • 1.165.0 (2025-02-27) — maintenance release, no component-specific changes
  • 1.138.1 (2024-10-30) — maintenance release, no component-specific changes
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 22 October 2026

Did this help?