ITextFieldProps

interface
Forms & Inputs

Full prop surface for <OrigamTextField> — extends field, input, color, density, padding/margin, border, rounded and elevation contracts, with autofocus, counter, placeholder, input type and mask support.

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.

autofocus
boolean
Focuses the input on mount.
counter
boolean | number | string
Shows a character counter. Pass a number to set the max displayed value.
counterValue
number | ((e: any) => number)
Custom function or fixed number for calculating the counter value.
placeholder
string
Placeholder text shown inside the input when it has no value.
persistentPlaceholder
boolean
Keeps the placeholder visible even when a value is set.
persistentCounter
boolean
Keeps the counter visible even when the input is not focused.
role
string
ARIA role override for the input element.
type
TTextFieldType
HTML input type. Defaults to 'text'.
modelModifiers
string | boolean
Vue model modifiers applied to the v-model binding.
mask
TMask
Input mask — built-in preset ('phone:fr'), raw pattern or options object. v-model receives the unmasked value.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Phone input with mask and counter

html