TextField

Single-line text input with label and validation.

Examples

Default

Project name

Shown on the dashboard.

import { TextField } from '@var-ui/react';

<TextField
  label="Project name"
  description="Shown on the dashboard."
  placeholder="My project"
/>

Props

Accessibility

Built on React Aria Components where applicable.

Props

Prop	Type	Default	Description
`description`	`string \| undefined`	—	Helper text shown below the control when there is no error.
`errorMessage`	`string \| undefined`	—	Validation message; when set, the field is shown in an error state.
`label`	`string \| undefined`	—	Visible label rendered above the control.
`placeholder`	`string \| undefined`	—	Placeholder text shown when the input is empty.
`size`	`ControlSize \| undefined`	—	—

React Aria props

Prop	Type	Default	Description
`aria-activedescendant`	`string \| undefined`	—	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
`aria-autocomplete`	`"none" \| "inline" \| "both" \| "list" \| undefined`	—	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
`aria-controls`	`string \| undefined`	—	Identifies the element (or elements) whose contents or presence are controlled by the current element.
`aria-describedby`	`string \| undefined`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string \| undefined`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-errormessage`	`string \| undefined`	—	Identifies the element that provides an error message for the object.
`aria-haspopup`	`boolean \| "true" \| "false" \| "menu" \| "listbox" \| "tree" \| "grid" \| "dialog" \| undefined`	—	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
`aria-label`	`string \| undefined`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string \| undefined`	—	Identifies the element (or elements) that labels the current element.
`autoComplete`	`string \| undefined`	—	Describes the type of autocomplete functionality the input should provide if any. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefautocomplete).
`autoCorrect`	`string \| undefined`	—	An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#autocomplete).
`autoFocus`	`boolean \| undefined`	—	Whether the element should receive focus on render.
`className`	`ClassNameOrFunction<TextFieldRenderProps> \| undefined`	`'react-aria-TextField'`	The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state.
`defaultValue`	`string \| undefined`	—	The default value (uncontrolled).
`dir`	`string \| undefined`	—	—
`enterKeyHint`	`"done" \| "search" \| "next" \| "enter" \| "go" \| "previous" \| "send" \| undefined`	—	An enumerated attribute that defines what action label or icon to preset for the enter key on virtual keyboards. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint).
`excludeFromTabOrder`	`boolean \| undefined`	—	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`form`	`string \| undefined`	—	The `<form>` element to associate the input with. The value of this attribute must be the id of a `<form>` in the same document. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#form).
`hidden`	`boolean \| undefined`	—	—
`id`	`string \| undefined`	—	The element's unique identifier. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/id).
`inert`	`boolean \| undefined`	—	—
`inputMode`	`"none" \| "text" \| "search" \| "tel" \| "url" \| "email" \| "numeric" \| "decimal" \| undefined`	—	Hints at the type of data that might be entered by the user while editing the element or its contents. See [MDN](https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute).
`isDisabled`	`boolean \| undefined`	—	Whether the input is disabled.
`isInvalid`	`boolean \| undefined`	—	Whether the value is invalid.
`isReadOnly`	`boolean \| undefined`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean \| undefined`	—	Whether user input is required on the input before form submission.
`lang`	`string \| undefined`	—	—
`maxLength`	`number \| undefined`	—	The maximum number of characters supported by the input. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefmaxlength).
`minLength`	`number \| undefined`	—	The minimum number of characters required by the input. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefminlength).
`name`	`string \| undefined`	—	The name of the input element, used when submitting an HTML form. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefname).
`onAnimationEnd`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationEndCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIteration`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationIterationCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStart`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAnimationStartCapture`	`AnimationEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onAuxClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onBeforeInput`	`FormEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the input value is about to be modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/beforeinput_event).
`onBlur`	`((e: FocusEvent<HTMLInputElement, Element>) => void) \| undefined`	—	Handler that is called when the element loses focus.
`onChange`	`((value: string) => void) \| undefined`	—	Handler that is called when the value changes.
`onClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a text composition system completes or cancels the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionend_event).
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a text composition system starts a new text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event).
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when a new character is received in the current text composition session. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionupdate_event).
`onContextMenu`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onContextMenuCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onCopy`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user copies text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncopy).
`onCut`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user cuts text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/oncut).
`onDoubleClick`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onDoubleClickCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onFocus`	`((e: FocusEvent<HTMLInputElement, Element>) => void) \| undefined`	—	Handler that is called when the element receives focus.
`onFocusChange`	`((isFocused: boolean) => void) \| undefined`	—	Handler that is called when the element's focus status changes.
`onGotPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onGotPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onInput`	`FormEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the input value is modified. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/input_event).
`onKeyDown`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is pressed.
`onKeyUp`	`((e: KeyboardEvent) => void) \| undefined`	—	Handler that is called when a key is released.
`onLostPointerCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onLostPointerCaptureCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDown`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseDownCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseEnter`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseLeave`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMove`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseMoveCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOut`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOutCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOver`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseOverCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUp`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onMouseUpCapture`	`MouseEventHandler<HTMLDivElement> \| undefined`	—	—
`onPaste`	`ClipboardEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when the user pastes text. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/onpaste).
`onPointerCancel`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerCancelCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDown`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerDownCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerEnter`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerLeave`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMove`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerMoveCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOut`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOutCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOver`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerOverCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUp`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onPointerUpCapture`	`PointerEventHandler<HTMLDivElement> \| undefined`	—	—
`onScroll`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onScrollCapture`	`UIEventHandler<HTMLDivElement> \| undefined`	—	—
`onSelect`	`ReactEventHandler<HTMLInputElement> \| undefined`	—	Handler that is called when text in the input is selected. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/select_event).
`onTouchCancel`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchCancelCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEnd`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchEndCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMove`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchMoveCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStart`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTouchStartCapture`	`TouchEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancel`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionCancelCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEnd`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionEndCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRun`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionRunCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStart`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onTransitionStartCapture`	`TransitionEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheel`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`onWheelCapture`	`WheelEventHandler<HTMLDivElement> \| undefined`	—	—
`pattern`	`string \| undefined`	—	Regex pattern that the value of the input must match to be valid. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdefpattern).
`render`	`DOMRenderFunction<"div", TextFieldRenderProps> \| undefined`	—	Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components. Requirements: - You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`). - Only a single root DOM element can be rendered (no fragments). - You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
`slot`	`string \| null \| undefined`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.
`spellCheck`	`string \| undefined`	—	An enumerated attribute that defines whether the element may be checked for spelling errors. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/spellcheck).
`style`	`StyleOrFunction<TextFieldRenderProps> \| undefined`	—	The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state.
`translate`	`"yes" \| "no" \| undefined`	—	—
`type`	`"text" \| (string & {}) \| "search" \| "tel" \| "url" \| "email" \| "password" \| undefined`	`'text'`	The type of input to render. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#htmlattrdeftype).
`validate`	`((value: string) => true \| ValidationError \| null \| undefined) \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`validationBehavior`	`"native" \| "aria" \| undefined`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`value`	`string \| undefined`	—	The current value (controlled).

Theme this component via createDesignTheme({ components: { textField: … } }). See Customize for the full override API.

Public classes and data attributes from @var-ui/core textField().

root

Name	Example	Description
`class`	`var-ui-text-field`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

label

Name	Example	Description
`class`	`var-ui-text-field__label`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

input

Name	Example	Description
`class`	`var-ui-text-field__input`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

description

Name	Example	Description
`class`	`var-ui-text-field__description`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

error

Name	Example	Description
`class`	`var-ui-text-field__error`	Root / part class name
`data-size`	`md`	Recipe variant / state attribute from `@var-ui/core`.

Apply via `recipeProps(recipe(…))` or copy the class / data attributes onto your markup.