TextInput

Beta notice: This page is being built.Edit on GitHub(opens in new tab)

Edits themed text with optional local state and native form serialization. Required fields cannot be blank.

longlink docs component "TextInput"

Example

TextInput - Properties
label`string` Label text for the input: always rendered for accessibility.
description`string` Description text displayed between the label and input.
name`string` Includes the themed control's value under this form submission name.
required`boolean` Requires a value before native form submission.
disabled`boolean` Prevents interaction and excludes the field from submission.
value`string` Current value of the input.
defaultValue`string` Initial value.
onChange`(value: string) => void` Callback fired when the input value changes.
placeholder`string` Placeholder text shown when the input is empty.
maxLength`number` Maximum Unicode code points, matching Python string length. Validates without truncating input.
type`"text" \| "password" \| "email"` The HTML input type.
autoComplete`string` Native autocomplete hint.
startIcon`ReactNode` Icon displayed at the start of the input.
onEnter`() => void` Runs on Enter, except when confirming an IME composition.

Beta notice: This page is being built.Edit on GitHub(opens in new tab)

Edits themed text with optional local state and native form serialization. Required fields cannot be blank.

longlink docs component "TextInput"

TextInput - Properties
label`string` Label text for the input: always rendered for accessibility.
description`string` Description text displayed between the label and input.
name`string` Includes the themed control's value under this form submission name.
required`boolean` Requires a value before native form submission.
disabled`boolean` Prevents interaction and excludes the field from submission.
value`string` Current value of the input.
defaultValue`string` Initial value.
onChange`(value: string) => void` Callback fired when the input value changes.
placeholder`string` Placeholder text shown when the input is empty.
maxLength`number` Maximum Unicode code points, matching Python string length. Validates without truncating input.
type`"text" \| "password" \| "email"` The HTML input type.
autoComplete`string` Native autocomplete hint.
startIcon`ReactNode` Icon displayed at the start of the input.
onEnter`() => void` Runs on Enter, except when confirming an IME composition.