Root Props
| Prop | Type | Default |
|---|---|---|
size | HelperTextSize | 'md' |
| Visual size of the helper text. Adjusts font size and spacing relative to form element size. | ||
error | boolean | — |
| Displays the helper text in an error state. Changes color to red. | ||
ref | Ref<HTMLSpanElement> | — |
Ref to the underlying <span> or slotted element. Useful for measuring, focusing, or DOM manipulation. | ||
asChild | boolean | — |
If true, renders the text as a child component using Slot. Useful for compatibility with native elements or other components. | ||
fontWeight | 400 | 500 | 600 | 700 | 900 | — |
| Font weight applied to the text. Common values: 400: Regular; 500: Medium; 600: Semi-bold; 700: Bold; 900: Extra bold | ||
Also accepts all <span> attributes.
Child Parts
- None.
HelperTextis a single exported primitive.
Types
HelperTextProps
State Model
HelperTexthas no controlled state.erroris a visual semantic toggle, not validation logic by itself.