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.

typescript

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.

centerAffix
boolean
Vertically center the prepend/append icons relative to the field height.
dirty
boolean
Mark the field as dirty (user has interacted with it).
disabled
boolean
Disable the field, preventing user interaction.
error
string | boolean
Error state: boolean paints the --error modifier; a string also becomes the inline error message.
inline
boolean
Render the field inline instead of as a block.
flat
boolean
Remove the default shadow/elevation from the field.
label
string
Floating label text.
prefix
string
Static text prepended inside the field.
suffix
string
Static text appended inside the field.
persistentClear
boolean
Always show the clear button, even when the field is empty.
singleLine
boolean
Hide the label when the field is focused or filled.
required
boolean
Mark the field as required, adding aria-required and a visual indicator.
reverse
boolean
Reverse the layout direction of the field.
activeColor
TColor
activeBgColor
TColor

É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

vue