IFieldProps
interface
Form & Input
Full prop surface for OrigamField — controls label, prefix/suffix, error state, disabled/dirty/required flags, and inherits color, density, variant, rounded, elevation, size, loader, focus and adjacent-inner surfaces.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- centerAffixboolean
- Vertically center the prepend/append icons relative to the field height.
- dirtyboolean
- Mark the field as dirty (user has interacted with it).
- disabledboolean
- Disable the field, preventing user interaction.
- errorstring | boolean
- Error state: boolean paints the --error modifier; a string also becomes the inline error message.
- inlineboolean
- Render the field inline instead of as a block.
- flatboolean
- Remove the default shadow/elevation from the field.
- labelstring
- Floating label text.
- prefixstring
- Static text prepended inside the field.
- suffixstring
- Static text appended inside the field.
- persistentClearboolean
- Always show the clear button, even when the field is empty.
- singleLineboolean
- Hide the label when the field is focused or filled.
- requiredboolean
- Mark the field as required, adding aria-required and a visual indicator.
- reverseboolean
- Reverse the layout direction of the field.
- activeColorTColor
- activeBgColorTColor
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Field with error state and label