FormControl
Native form submission boundary with optional full-width layout styling.
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 { FormControl } from "@tavojs/ui/form-control";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/form-control.
When to use
Use it when
Choose something else when
Examples
FormControl example
tsximport { FormControl } from "@tavojs/ui/form-control";
import { TextInput } from "@tavojs/ui";
export function FormControlExample1() {
return (
<>
<FormControl fullWidth><TextInput /></FormControl>
</>
);
}Common props and defaults
| Prop | Type | Default | Description |
|---|---|---|---|
className | string | — | Optional class hook applied to the public root element owned by the component. |
fullWidth | boolean | — | Configures fullWidth for this component. |
Complete TypeScript API
Import from @tavojs/ui/form-control. Published exports: FormControl, FormControlProps.
FormControlProps
| Property | Type | Required | Description |
|---|---|---|---|
children | Child | No | Inherited children attribute accepted by FormControl. |
className | string | No | Optional class hook applied to the public root element owned by the component. |
sx | Sx | No | Inherited sx attribute accepted by FormControl. |
id | string | No | Inherited id attribute accepted by FormControl. |
role | string | No | Inherited role attribute accepted by FormControl. |
style | Record<string, unknown> | No | Inherited style attribute accepted by FormControl. |
title | string | No | Inherited title attribute accepted by FormControl. |
tabIndex | number | No | Inherited tabIndex attribute accepted by FormControl. |
hidden | boolean | No | Inherited hidden attribute accepted by FormControl. |
disabled | boolean | No | Inherited disabled attribute accepted by FormControl. |
onClick | TavoEventHandler<MouseEvent> | No | Inherited onClick attribute accepted by FormControl. |
onChange | TavoEventHandler<Event> | No | Inherited onChange attribute accepted by FormControl. |
onInput | TavoEventHandler<Event> | No | Inherited onInput attribute accepted by FormControl. |
onKeyDown | TavoEventHandler<KeyboardEvent> | No | Inherited onKeyDown attribute accepted by FormControl. |
onFocus | TavoEventHandler<FocusEvent> | No | Inherited onFocus attribute accepted by FormControl. |
onBlur | TavoEventHandler<FocusEvent> | No | Inherited onBlur attribute accepted by FormControl. |
fullWidth | boolean | No | Configures fullWidth for this component. |
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
Limitations
Do not use FormControl as a replacement for Field. It does not create labels, hints, validation messages, or ARIA relationships for individual controls.
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/form-control |
| Explicit CSS import | @tavojs/ui/css/form-control |
| Preview | Interactive preview available on this page |