Basic
Labeled text input.
Flexible text input with adornments, validation states, and form integration.
Import the component and configure it with the same props used in the playground.
Common patterns and practical usage examples.
Labeled text input.
Shows a clear action when a value is present.
Shows progress while the field is waiting on work.
Validation feedback state.
Preserves value display without allowing edits.
Password input with reveal control.
Character count when maxLength is set.
Props available for the React Input.
| Prop | Type | Default | Description |
|---|---|---|---|
type | import( | 'text' | Native input type. Search automatically adds a start search icon. |
value | string | - | Controlled value. |
defaultValue | string | - | Initial uncontrolled value. |
onValueChange | ( | - | Called with the next string value. |
id | string | - | Control id. Inherits the generated FormField id when omitted. |
name | string | - | Native input name. |
startIcon | ReactNode | - | Icon rendered at the start of the control. |
endIcon | ReactNode | - | Icon rendered in the right slot when no higher-priority action is active. |
startAddon | ReactNode | - | Segmented addon rendered before the input. |
endAddon | ReactNode | - | Segmented addon rendered after the input. |
prefix | ReactNode | - | Inline prefix rendered inside the input chrome. |
suffix | ReactNode | - | Inline suffix rendered inside the input chrome. |
clearIcon | ReactNode | - | Custom clear action content. Defaults to a compact x. |
mask | InputMask | - | Input mask. String masks use # as a digit placeholder. |
format | InputFormatter | - | Formats the displayed value without changing the controlled value. |
parse | InputParser | - | Parses a formatted display value before mask/onValueChange. |
startIconTone | 'default' | 'default' | Tone for startIcon. |
endIconTone | 'default' | 'default' | Tone for endIcon. |
clearIconTone | 'default' | 'danger' | Tone for clearIcon. |
wrapperClassName | string | - | Class name applied to the outer FormField wrapper in shorthand mode. |
className | string | - | Class name applied to the native input element. |
autoComplete | string | - | Native autocomplete value. When omitted, sensible values are derived from type. |
label | string | - | Visible field label. |
description | string | - | Supporting text rendered with the field and linked to the control. |
placeholder | string | - | Placeholder shown when the value is empty. |
size | 'sm' | 'md' | Field size. Inherits from FormField when omitted by compatible controls. |
color | 'primary' | 'primary' | Semantic color palette for the control. |
variant | 'outline' | 'outline' | Visual variant for the control chrome. |
disabled | boolean | false | Disables interaction. Also inherited from FormField by compatible controls. |
readOnly | boolean | false | Makes the control non-editable while preserving focus and value semantics. |
required | boolean | false | Marks the field as required. Also inherited from FormField. |
invalid | boolean | false | Shows invalid styling without requiring error text. Also inherited from FormField. |
loading | boolean | false | Shows a spinner in the right slot and makes the field read-only. |
clearable | boolean | false | Shows a clear action when the field has a value. |
onClear | ( | - | Called when the clear action is activated. |
revealPassword | boolean | false | Shows a password visibility toggle for password inputs. |
showCounter | boolean | false | Shows the current character count when maxLength is provided. |
error | string | - | Error message. Also implies invalid state. |
These props are forwarded to the underlying React DOM element.
| Prop | Type | Description |
|---|---|---|
form | string | - |
slot | string | - |
style | CSSProperties | - |
title | string | - |
pattern | string | - |
key | Key | - |
accept | string | - |
alt | string | - |
capture | boolean | - |
checked | boolean | - |
formAction |
| - |
formEncType | string | - |
formMethod | string | - |
formNoValidate | boolean | - |
formTarget | string | - |
height | string | - |
list | string | - |
max | string | - |
maxLength | number | - |
min | string | - |
minLength | number | - |
multiple | boolean | - |
src | string | - |
step | string | - |
width | string | - |
defaultChecked | boolean | - |
suppressContentEditableWarning | boolean | - |
suppressHydrationWarning | boolean | - |
accessKey | string | - |
autoCapitalize |
| - |
autoFocus | boolean | - |
contentEditable |
| - |
contextMenu | string | - |
dir | string | - |
draggable | Booleanish | - |
enterKeyHint |
| - |
hidden | boolean | - |
lang | string | - |
nonce | string | - |
spellCheck | Booleanish | - |
tabIndex | number | - |
translate | 'yes' | - |
radioGroup | string | - |
role | AriaRole | - |
about | string | - |
content | string | - |
datatype | string | - |
inlist | any | - |
property | string | - |
rel | string | - |
resource | string | - |
rev | string | - |
typeof | string | - |
vocab | string | - |
autoCorrect | string | - |
autoSave | string | - |
itemProp | string | - |
itemScope | boolean | - |
itemType | string | - |
itemID | string | - |
itemRef | string | - |
results | number | - |
security | string | - |
unselectable | 'off' | - |
popover |
| - |
popoverTargetAction | 'toggle' | - |
popoverTarget | string | - |
inert | boolean | - |
inputMode |
| Show descriptionHints at the type of data that might be entered by the user while editing the element or its contents |
is | string | Show descriptionSpecify that a standard HTML element should behave like a defined custom built-in element |
exportparts | string | - |
part | string | - |
aria-activedescendant | string | Show descriptionIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. |
aria-atomic | Booleanish | Show descriptionIndicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute. |
aria-autocomplete |
| Show descriptionIndicates 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-braillelabel | string | Show descriptionDefines a string value that labels the current element, which is intended to be converted into Braille. |
aria-brailleroledescription | string | Show descriptionDefines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille. |
aria-busy | Booleanish | - |
aria-checked |
| Show descriptionIndicates the current "checked" state of checkboxes, radio buttons, and other widgets. |
aria-colcount | number | Show descriptionDefines the total number of columns in a table, grid, or treegrid. |
aria-colindex | number | Show descriptionDefines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid. |
aria-colindextext | string | Show descriptionDefines a human readable text alternative of aria-colindex. |
aria-colspan | number | Show descriptionDefines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-controls | string | Show descriptionIdentifies the element (or elements) whose contents or presence are controlled by the current element. |
aria-current |
| Show descriptionIndicates the element that represents the current item within a container or set of related elements. |
aria-describedby | string | Show descriptionIdentifies the element (or elements) that describes the object. |
aria-description | string | Show descriptionDefines a string value that describes or annotates the current element. |
aria-details | string | Show descriptionIdentifies the element that provides a detailed, extended description for the object. |
aria-disabled | Booleanish | Show descriptionIndicates that the element is perceivable but disabled, so it is not editable or otherwise operable. |
aria-dropeffect |
| Show descriptionIndicates what functions can be performed when a dragged object is released on the drop target. |
aria-errormessage | string | Show descriptionIdentifies the element that provides an error message for the object. |
aria-expanded | Booleanish | Show descriptionIndicates whether the element, or another grouping element it controls, is currently expanded or collapsed. |
aria-flowto | string | Show descriptionIdentifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order. |
aria-grabbed | Booleanish | Show descriptionIndicates an element's "grabbed" state in a drag-and-drop operation. |
aria-haspopup |
| Show descriptionIndicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element. |
aria-hidden | Booleanish | Show descriptionIndicates whether the element is exposed to an accessibility API. |
aria-invalid |
| Show descriptionIndicates the entered value does not conform to the format expected by the application. |
aria-keyshortcuts | string | Show descriptionIndicates keyboard shortcuts that an author has implemented to activate or give focus to an element. |
aria-label | string | Show descriptionDefines a string value that labels the current element. |
aria-labelledby | string | Show descriptionIdentifies the element (or elements) that labels the current element. |
aria-level | number | Show descriptionDefines the hierarchical level of an element within a structure. |
aria-live | 'off' | Show descriptionIndicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region. |
aria-modal | Booleanish | Show descriptionIndicates whether an element is modal when displayed. |
aria-multiline | Booleanish | Show descriptionIndicates whether a text box accepts multiple lines of input or only a single line. |
aria-multiselectable | Booleanish | Show descriptionIndicates that the user may select more than one item from the current selectable descendants. |
aria-orientation | 'horizontal' | Show descriptionIndicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. |
aria-owns | string | Show descriptionIdentifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship. |
aria-placeholder | string | Show descriptionDefines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format. |
aria-posinset | number | Show descriptionDefines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
aria-pressed |
| Show descriptionIndicates the current "pressed" state of toggle buttons. |
aria-readonly | Booleanish | Show descriptionIndicates that the element is not editable, but is otherwise operable. |
aria-relevant |
| Show descriptionIndicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. |
aria-required | Booleanish | Show descriptionIndicates that user input is required on the element before a form may be submitted. |
aria-roledescription | string | Show descriptionDefines a human-readable, author-localized description for the role of an element. |
aria-rowcount | number | Show descriptionDefines the total number of rows in a table, grid, or treegrid. |
aria-rowindex | number | Show descriptionDefines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid. |
aria-rowindextext | string | Show descriptionDefines a human readable text alternative of aria-rowindex. |
aria-rowspan | number | Show descriptionDefines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. |
aria-selected | Booleanish | Show descriptionIndicates the current "selected" state of various widgets. |
aria-setsize | number | Show descriptionDefines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM. |
aria-sort |
| Show descriptionIndicates if items in a table or grid are sorted in ascending or descending order. |
aria-valuemax | number | Show descriptionDefines the maximum allowed value for a range widget. |
aria-valuemin | number | Show descriptionDefines the minimum allowed value for a range widget. |
aria-valuenow | number | Show descriptionDefines the current value for a range widget. |
aria-valuetext | string | Show descriptionDefines the human readable text alternative of aria-valuenow for a range widget. |
children | ReactNode | - |
dangerouslySetInnerHTML | { | - |
onCopy | ClipboardEventHandler< | - |
onCopyCapture | ClipboardEventHandler< | - |
onCut | ClipboardEventHandler< | - |
onCutCapture | ClipboardEventHandler< | - |
onPaste | ClipboardEventHandler< | - |
onPasteCapture | ClipboardEventHandler< | - |
onCompositionEnd |
| - |
onCompositionEndCapture |
| - |
onCompositionStart |
| - |
onCompositionStartCapture |
| - |
onCompositionUpdate |
| - |
onCompositionUpdateCapture |
| - |
onFocus | FocusEventHandler< | - |
onFocusCapture | FocusEventHandler< | - |
onBlur | FocusEventHandler< | - |
onBlurCapture | FocusEventHandler< | - |
onChangeCapture |
| - |
onBeforeInput | InputEventHandler< | - |
onBeforeInputCapture | InputEventHandler< | - |
onInput | InputEventHandler< | - |
onInputCapture | InputEventHandler< | - |
onReset | ReactEventHandler< | - |
onResetCapture | ReactEventHandler< | - |
onSubmit | SubmitEventHandler< | - |
onSubmitCapture | SubmitEventHandler< | - |
onInvalid | ReactEventHandler< | - |
onInvalidCapture | ReactEventHandler< | - |
onLoad | ReactEventHandler< | - |
onLoadCapture | ReactEventHandler< | - |
onError | ReactEventHandler< | - |
onErrorCapture | ReactEventHandler< | - |
onKeyDown | KeyboardEventHandler< | - |
onKeyDownCapture | KeyboardEventHandler< | - |
onKeyPress | KeyboardEventHandler< | - |
onKeyPressCapture | KeyboardEventHandler< | - |
onKeyUp | KeyboardEventHandler< | - |
onKeyUpCapture | KeyboardEventHandler< | - |
onAbort | ReactEventHandler< | - |
onAbortCapture | ReactEventHandler< | - |
onCanPlay | ReactEventHandler< | - |
onCanPlayCapture | ReactEventHandler< | - |
onCanPlayThrough | ReactEventHandler< | - |
onCanPlayThroughCapture | ReactEventHandler< | - |
onDurationChange | ReactEventHandler< | - |
onDurationChangeCapture | ReactEventHandler< | - |
onEmptied | ReactEventHandler< | - |
onEmptiedCapture | ReactEventHandler< | - |
onEncrypted | ReactEventHandler< | - |
onEncryptedCapture | ReactEventHandler< | - |
onEnded | ReactEventHandler< | - |
onEndedCapture | ReactEventHandler< | - |
onLoadedData | ReactEventHandler< | - |
onLoadedDataCapture | ReactEventHandler< | - |
onLoadedMetadata | ReactEventHandler< | - |
onLoadedMetadataCapture | ReactEventHandler< | - |
onLoadStart | ReactEventHandler< | - |
onLoadStartCapture | ReactEventHandler< | - |
onPause | ReactEventHandler< | - |
onPauseCapture | ReactEventHandler< | - |
onPlay | ReactEventHandler< | - |
onPlayCapture | ReactEventHandler< | - |
onPlaying | ReactEventHandler< | - |
onPlayingCapture | ReactEventHandler< | - |
onProgress | ReactEventHandler< | - |
onProgressCapture | ReactEventHandler< | - |
onRateChange | ReactEventHandler< | - |
onRateChangeCapture | ReactEventHandler< | - |
onSeeked | ReactEventHandler< | - |
onSeekedCapture | ReactEventHandler< | - |
onSeeking | ReactEventHandler< | - |
onSeekingCapture | ReactEventHandler< | - |
onStalled | ReactEventHandler< | - |
onStalledCapture | ReactEventHandler< | - |
onSuspend | ReactEventHandler< | - |
onSuspendCapture | ReactEventHandler< | - |
onTimeUpdate | ReactEventHandler< | - |
onTimeUpdateCapture | ReactEventHandler< | - |
onVolumeChange | ReactEventHandler< | - |
onVolumeChangeCapture | ReactEventHandler< | - |
onWaiting | ReactEventHandler< | - |
onWaitingCapture | ReactEventHandler< | - |
onAuxClick | MouseEventHandler< | - |
onAuxClickCapture | MouseEventHandler< | - |
onClick | MouseEventHandler< | - |
onClickCapture | MouseEventHandler< | - |
onContextMenu | MouseEventHandler< | - |
onContextMenuCapture | MouseEventHandler< | - |
onDoubleClick | MouseEventHandler< | - |
onDoubleClickCapture | MouseEventHandler< | - |
onDrag | DragEventHandler< | - |
onDragCapture | DragEventHandler< | - |
onDragEnd | DragEventHandler< | - |
onDragEndCapture | DragEventHandler< | - |
onDragEnter | DragEventHandler< | - |
onDragEnterCapture | DragEventHandler< | - |
onDragExit | DragEventHandler< | - |
onDragExitCapture | DragEventHandler< | - |
onDragLeave | DragEventHandler< | - |
onDragLeaveCapture | DragEventHandler< | - |
onDragOver | DragEventHandler< | - |
onDragOverCapture | DragEventHandler< | - |
onDragStart | DragEventHandler< | - |
onDragStartCapture | DragEventHandler< | - |
onDrop | DragEventHandler< | - |
onDropCapture | DragEventHandler< | - |
onMouseDown | MouseEventHandler< | - |
onMouseDownCapture | MouseEventHandler< | - |
onMouseEnter | MouseEventHandler< | - |
onMouseLeave | MouseEventHandler< | - |
onMouseMove | MouseEventHandler< | - |
onMouseMoveCapture | MouseEventHandler< | - |
onMouseOut | MouseEventHandler< | - |
onMouseOutCapture | MouseEventHandler< | - |
onMouseOver | MouseEventHandler< | - |
onMouseOverCapture | MouseEventHandler< | - |
onMouseUp | MouseEventHandler< | - |
onMouseUpCapture | MouseEventHandler< | - |
onSelect | ReactEventHandler< | - |
onSelectCapture | ReactEventHandler< | - |
onTouchCancel | TouchEventHandler< | - |
onTouchCancelCapture | TouchEventHandler< | - |
onTouchEnd | TouchEventHandler< | - |
onTouchEndCapture | TouchEventHandler< | - |
onTouchMove | TouchEventHandler< | - |
onTouchMoveCapture | TouchEventHandler< | - |
onTouchStart | TouchEventHandler< | - |
onTouchStartCapture | TouchEventHandler< | - |
onPointerDown | PointerEventHandler< | - |
onPointerDownCapture | PointerEventHandler< | - |
onPointerMove | PointerEventHandler< | - |
onPointerMoveCapture | PointerEventHandler< | - |
onPointerUp | PointerEventHandler< | - |
onPointerUpCapture | PointerEventHandler< | - |
onPointerCancel | PointerEventHandler< | - |
onPointerCancelCapture | PointerEventHandler< | - |
onPointerEnter | PointerEventHandler< | - |
onPointerLeave | PointerEventHandler< | - |
onPointerOver | PointerEventHandler< | - |
onPointerOverCapture | PointerEventHandler< | - |
onPointerOut | PointerEventHandler< | - |
onPointerOutCapture | PointerEventHandler< | - |
onGotPointerCapture | PointerEventHandler< | - |
onGotPointerCaptureCapture | PointerEventHandler< | - |
onLostPointerCapture | PointerEventHandler< | - |
onLostPointerCaptureCapture | PointerEventHandler< | - |
onScroll | UIEventHandler< | - |
onScrollCapture | UIEventHandler< | - |
onScrollEnd | UIEventHandler< | - |
onScrollEndCapture | UIEventHandler< | - |
onWheel | WheelEventHandler< | - |
onWheelCapture | WheelEventHandler< | - |
onAnimationStart | AnimationEventHandler< | - |
onAnimationStartCapture | AnimationEventHandler< | - |
onAnimationEnd | AnimationEventHandler< | - |
onAnimationEndCapture | AnimationEventHandler< | - |
onAnimationIteration | AnimationEventHandler< | - |
onAnimationIterationCapture | AnimationEventHandler< | - |
onToggle | ToggleEventHandler< | - |
onBeforeToggle | ToggleEventHandler< | - |
onTransitionCancel | TransitionEventHandler< | - |
onTransitionCancelCapture | TransitionEventHandler< | - |
onTransitionEnd | TransitionEventHandler< | - |
onTransitionEndCapture | TransitionEventHandler< | - |
onTransitionRun | TransitionEventHandler< | - |
onTransitionRunCapture | TransitionEventHandler< | - |
onTransitionStart | TransitionEventHandler< | - |
onTransitionStartCapture | TransitionEventHandler< | - |
Guidance for accessible usage and interaction.
labeldescriptionplaceholdererrorinvalidrequiredreadOnlydisabled