TextInput
Token-styled native input element for text-like values.
Preview
A live, theme-aware example rendered with the published component.
Loading preview…
Import
Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.
tsximport { TextInput } from "@tavojs/ui/text-input";Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/text-input.
When to use
Use it when
Choose something else when
Examples
TextInput example
tsximport { TextInput } from "@tavojs/ui/text-input";
export function TextInputExample1() {
return (
<>
<TextInput placeholder="Email" />
</>
);
}Common props and defaults
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
size | Size | — | Configures size for this component. |
Complete TypeScript API
Import from @tavojs/ui/text-input. Published exports: TextInput, TextInputProps.
TextInputProps
| Property | Type | Required | Description |
|---|---|---|---|
className | string | No | Optional class hook applied to the public root element owned by the component. |
size | Size | No | Configures size for this component. |
onChange | ValueChangeHandler<HTMLInputElement> | No | Inherited onChange attribute accepted by TextInput. |
onInput | ValueChangeHandler<HTMLInputElement> | No | Inherited onInput attribute accepted by TextInput. |
State ownership and DOM target
| Concern | Contract |
|---|---|
| State | No component state contract is exposed; the application owns the rendered content and surrounding behavior. |
| DOM target | Native input attributes target the owned form control; wrapper-specific props stay on the documented component root. |
Anatomy and related components
This component exposes one public component root rather than a compound member API.
Limitations
TextInput does not generate a visible label or supporting messages. Wrap it in Field for label, hint, validation, required-state, and ARIA wiring.
Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.
Accessibility
Form components pass through native attributes and should be paired with visible labels or accessible names.
Use Field, FormLabel, FormControlLabel, or aria-label for labeling.
Preserve native input semantics whenever possible.
Expose validation with error text and aria-invalid where relevant.
Component status
| Contract | Current value |
|---|---|
| Maturity | stable |
| Category | forms |
| Component import | @tavojs/ui/text-input |
| Explicit CSS import | @tavojs/ui/css/text-input |
| Preview | Interactive preview available on this page |