ListItemEditable

Components/Form

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

Overview

Copy

ListItemEditable is an internal editable component which is used to build dropdown or menu like components. Usually this item should not be used by consumers, though custom options builder is exposed for usage with DropdownBase.

Feature examples

With a status

Setting a status to indicate some there's an issue.

Copy

Part of a dropdown

The editable list item can be used alongside any other list item, build by a dedicated builder

Copy

Code

Copy

Props

NameTypeDefaultDescription
approveButtonDisabledOnEmptybooleantrueMake the approve button disabled when input value is empty.
approveButtonTooltipContentReactNode—Approve button tooltip content.
approveButtonTooltipPropsTooltipCommonProps—Approve button tooltip common props.
autoFocusboolean—Focus the input on mount (standard React input autoFocus)
cancelButtonTooltipContentReactNode—Cancel button tooltip content.
cancelButtonTooltipPropsTooltipCommonProps—Cancel button tooltip common props.
dataHookstring—Applied as data-hook HTML attribute that can be used in the tests.
margins"none" | "list-item" | "none" | "list-item"—The type of margin.
maxLengthnumber—Maximum number of characters allowed in the input.
onApprove(value: string) => void—A callback function triggered by clicking the approve button. ##### Signature: function(value: string) => void * value: the text contained in the input.
onCancel() => void—A callback function triggered by clicking the cancel button. ##### Signature: function() => void.
onChangeChangeEventHandler—Defines a standard input onChange callback.
onEnterPressedKeyboardEventHandler<HTMLInputElement>—Defines a callback handler that is called when the user presses enter on the input element.
placeholderstring—Placeholder to display.
size"small" | "medium"—Specifies the size of the input.
status"error" | "warning" | "loading"—Input status - use to display an status indication for the user.
statusMessageReactNode—The status (error/loading) message to display when hovering the status icon, if not given or empty, no tooltip is displayed.
suffixReactNode—Pass a component you want to show as the suffix of the input, e.g., text, icon.
valuestring—Initial value to display with component render.

Testkit

Import the driver matching your test environment:

Copy

Driver methods

MethodDescription
getValueA getter for the value
getPlaceholderA getter for the placeholder
isApproveButtonDisabledReturns true it the approve button is disabled
enterTextSimulated writing text in the input
clickApproveSimulates clicking the approve button
clickCancelSimulates clicking the cancel button
pressEnterSimulates clicking the enter key
isFocusReturns true if input element is focused
hasSuffixReturns true if input element has suffix
getCancelButtonTooltipTextReturns cancel button tooltip text
getApproveButtonTooltipTextReturns approve button tooltip text
hasStatusReturn true if the given status is displayed
getStatusMessageIf there's a status message, returns its text value
getMaxLengthReturns the maxLength attribute value
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) — 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.330.3 (2026-09-29) — maintenance release, no component-specific changes
  • 1.330.0 (2026-09-28) — maintenance release, no component-specific changes
  • 1.325.0 (2026-09-17) — maintenance release, no component-specific changes
  • 1.320.0 (2026-09-03) — 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.267.0 (2026-04-09) — 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.256.0 (2026-02-06) — feat: add maxLength (#15905)
  • 1.242.0 (2025-12-19) — maintenance release, no component-specific changes
  • 1.210.0 (2025-08-04) — maintenance release, no component-specific changes
  • 1.172.0 (2025-03-20) — 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.114.0 (2024-07-11) — 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?