IMaskOptions

interface
Mask

Configuration object accepted by useMask and the OrigamTextField mask prop in its long form. Defines the pattern template, an optional secondary validator, and a required flag.

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

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.

pattern
requis
string
Token-walker template string. # = digit, A = letter, * = any char, anything else is a literal preserved verbatim.
validator
TPatternValidator | null
Optional secondary check on the UNMASKED value (e.g. Luhn algorithm for credit cards).
required
boolean
When true, isValid is false until every consumer token in the pattern is filled.

É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 number mask with validation

typescript