Components/Form/InputWithLabel
Interactive docs page: https://wix-pages.com/design-system-documentation/#/component/inputwithlabel
InputWithLabel allows you to insert short text values in a field with a built-in label. It's constructed by wrapping a regular <Input/> component with <LabeledElement/>.
<FormField/> with <Input/> instead.Control component status using `status` prop. It supports two states:
 - `error` - use it to highlight an invalid value
 - `warning` - use it to highlight a value that impacts user business or can't be validated
Explain the status with `statusMessage` prop.
Explain the status with `statusMessage` prop. The message is shown below the field, next to the status icon.
Disable all input interactions with `disabled` prop. Use it to highlight unavailable functions.
Explain field values with additional information added to the `suffix` area. This prop accepts text, icons and even buttons. It accepts an array of objects as well.
Control an acceptable value format with the `type` prop. This component accepts all native HTML types.
Restrict the number of characters that can be entered into a field with the `maxLength` prop.
Style the component using `border` prop. It supports 2 styles:
 - `default` - use in all common cases.
 - `bottomLine` - use as a title which can be edited on the click.
This input with labels can only be used to build a Premium Checkout form.
| Name | Type | Default | Description |
|---|---|---|---|
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 | — | Sets the value of the native autocomplete attribute, for example off or email. |
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 | "standard" | "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. |
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. |
enterKeyHint | "search" | "enter" | "done" | "go" | "next" | "previous" | "send" | — | Sets the label of the virtual keyboard's enter key on touch devices. |
focusOnClearClick | boolean | — | Specifies whether to focus the field when clear button is clicked. |
hideStatusSuffix | boolean | — | Specifies whether status suffix should be hidden. |
id | string | — | Assigns a unique identifier for the root element. |
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. |
label | string | — | Sets the field label. |
max | number | — | Sets a maximum value of an input. Similar to html5 max attribute. |
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. |
name | string | — | Reference element data when a form is submitted. |
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. |
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) |
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. |
onPaste | ClipboardEventHandler<HTMLInputElement> | — | Defines a callback handler that is called when user pastes text from a clipboard (using a mouse or keyboard shortcut) |
pattern | string | — | Sets a pattern that typed value must match to be valid (regex) |
placeholder | string | — | Sets a placeholder message to display. |
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. |
ref | null | string | (instance: InputImperativeActions | null) => void | RefObject<InputImperativeActions> | — | 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). |
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. |
size | "small" | "tiny" | "medium" | "large" | — | Controls the size of the input. Default value: medium |
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. |
withSelection | boolean | — |
Import the driver matching your test environment:
| Method | Description |
|---|---|
getSuffixesCount | Gets the amount of rendered suffixes |
hasErrorMessage | Returns true if an error status message exists |
getErrorMessage | Gets the error status message |
getValue | — |
clickInput | — |
enterText | — |
getLabelText | — |
isCustomInput | — |
isFocusedStyle | — |
getMaxLength | — |
getPlaceholder | — |
exists | Checks whether the component found with the given data hook. |
element | Gets the component root element. |
click | Clicks on the component root element. |
base | Returns UniDriver for the base element. |
Last updated: 30 October 2026