ListItemAction

Components/Form

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

Overview

Copy

ListItemAction component is used to build menu like components.

Do

  • Use it to build navigation menus

Don't

  • Don't use it for selection based menus

Feature examples

Affix

Add text, icons or a button at the beginning or end of a text field using prefixIcon and suffix.

Copy

Skin

List item supports three skins:

  • standard
  • destructive
  • premium
Copy

Disabled

Supports disabled state.

Optionally, tooltips on hover are available to explain disabled states with disabledDescription

Copy

Text ellipsis

Text can be set to be ellipsed on tight container width.

Tooltips on truncated text will be overridden if the component is disabled. In that case, it will show disabledDescription first.

Copy

Subtitle

A subtitle text can be set with subtitle

Copy

Advanced example

All properties work together and can be combined in various ways. It can be rendered as standalone or as part of dropdown.

Copy

Code

Copy

Props

NameTypeDefaultDescription
as"button"—Render as 'button' element.
autoFocusboolean—When present, it specifies that a button should automatically get focus when the page loads.
dataHookstring—Data attribute for testing purposes.
disabledboolean—Specifies whether the list item is disabled. A disabled item ignores click, key down and mouse events.
disabledDescriptionstring—Tooltip description if item is disabled.
ellipsisboolean—Should the text get ellipsed with tooltip, or should it get broken into lines when it reaches the end of its container.
highlightedboolean—If true, the item is highlighted, if false - highlighted styles aren't automatically applied on item hover.
onClickMouseEventHandler—Click event handler.
onMouseEnterMouseEventHandler—Mouse enter event handler.
onMouseLeaveMouseEventHandler—Mouse leave event handler.
prefixIconReactElement—Accepts an icon to render before the title.
refnull | string | (instance: ListItemActionRefProps | null) => void | RefObject<ListItemActionRefProps>—Allows getting a ref to the component instance. Once the component unmounts, React will set ref.current to null (or call the ref with null if you passed a callback ref).
shouldFocusWithoutScrollboolean—Specifies whether page should be scrolled to the focused item.
size"small" | "medium"mediumText Size (small, medium).
skin"standard" | "destructive" | "premium" | "dark" | "primary"standardItem theme (standard, dark, destructive, premium, primary).
subtitlestring—Text of the list item subtitle.
suffixReactNode—Accepts any content to render after the title.
suffixIconReactElement—Accepts an icon to render at the end of the list item.
title (required)ReactNode—Sets the title of the list item.
tooltipModifiersEllipsisCommonProps—Tooltip floating modifiers.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
isTitleExists—
getTitleText—
isPrefixIconExists—
isSuffixIconExists—
isSubtitleExists—
getSubtitleText—
isSuffixExists—
getSuffixText—
getSkin—
isDisabled—
mouseEnter—
mouseLeave—
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.344.0 (2026-10-28) — maintenance release, no component-specific changes
  • 1.340.0 (2026-10-21) — fix: import React in the prop types, so listItemActionBuilder params and ListItemAction props no longer resolve to any (#17551)
  • 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.337.0 (2026-10-14) — 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.328.0 (2026-09-22) — 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.313.1 (2026-08-18) — maintenance release, no component-specific changes
  • 1.310.0 (2026-08-10) — maintenance release, no component-specific changes
  • 1.298.0 (2026-07-14) — breaking: reimagine Harmony theme styling (#16513) — has visual changes
  • 1.292.0 (2026-06-22) — maintenance release, no component-specific changes
  • 1.277.0 (2026-05-07) — feat: add destructive skin hover tokens (#16240)
  • 1.273.0 (2026-04-30) — feat: add fill token and update list-item backgrounds for odeditor-dark (#16210)
  • 1.272.0 (2026-04-27) — 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.247.2 (2026-01-21) — maintenance release, no component-specific changes
  • 1.245.0 (2026-01-06) — feat: adds onMouseEnter and onMouseLeave handlers to ListItemAction (#15745)
  • 1.232.0 (2025-11-28) — maintenance release, no component-specific changes
  • 1.216.0 (2025-09-01) — maintenance release, no component-specific changes
  • 1.213.0 (2025-08-19) — breaking: additional tokenization for editor3 (#15198)
  • 1.212.0 (2025-08-11) — maintenance release, no component-specific changes
  • 1.205.0 (2025-07-15) — maintenance release, no component-specific changes
  • 1.204.0 (2025-07-03) — maintenance release, no component-specific changes
  • 1.202.0 (2025-06-27) — feat: expanded title type to ReactNode (#15019)
  • 1.181.0 (2025-04-18) — maintenance release, no component-specific changes
  • 1.180.0 (2025-04-14) — maintenance release, no component-specific changes
  • 1.176.0 (2025-04-02) — maintenance release, no component-specific changes
  • 1.172.1 (2025-03-21) — maintenance release, no component-specific changes
  • 1.172.0 (2025-03-20) — breaking: change List item action font size & line height in both themes (#14586)
  • 1.146.0 (2024-12-10) — maintenance release, no component-specific changes
  • 1.124.0 (2024-09-06) — maintenance release, no component-specific changes
  • 1.120.1 (2024-08-08) — maintenance release, no component-specific changes
  • 1.120.0 (2024-08-02) — maintenance release, no component-specific changes
  • 1.116.0 (2024-07-22) — fix: font blink and no background (#13969)
  • 1.116.0 (2024-07-22) — feat: add primary skin. (#13946)
  • 1.114.0 (2024-07-11) — maintenance release, no component-specific changes
  • 1.105.0 (2024-05-21) — feat: add premium skin (#13729)
  • 1.104.1 (2024-05-14) — breaking: fix suffix truncation (#13721)
  • 1.103.1 (2024-04-24) — maintenance release, no component-specific changes
  • 1.103.0 (2024-04-23) — feat: tokenized (#13578)
  • 1.102.0 (2024-04-16) — maintenance release, no component-specific changes
  • 1.100.0 (2024-04-04) — feat: add mobile breakpoint (#13546)
  • 1.98.0 (2024-03-15) — maintenance release, no component-specific changes
  • 1.93.0 (2024-02-08) — maintenance release, no component-specific changes
  • 1.92.1 (2024-02-05) — maintenance release, no component-specific changes

Last updated: 30 October 2026

Did this help?