BUILT_IN_PATTERNS
const
Form & Input
Curated mask presets map (name → { pattern, validator }). Covers common formats: French/US/international phone, IBAN, SIRET, credit card, ISO date, FR/US date, time, and postal codes.
TypeScript
Definition
The TypeScript definition as found in the origam source. Click the copy icon to copy the snippet.
Entries
Values
All entries in this constant. Click a value to copy it to clipboard.
- [BUILT_IN_PATTERN.PHONE_FR]: { pattern: '## ## ## ## ##', validator: null }
- [BUILT_IN_PATTERN.PHONE_US]: { pattern: '(###) ###-####', validator: null }
- [BUILT_IN_PATTERN.PHONE_INTERNATIONAL]: { pattern: '+## ## ## ## ## ##', validator: null }
- [BUILT_IN_PATTERN.IBAN]: { // IBAN max length is 34, FR is 27, EN is 22. // Pattern accepts up to 34 alphanumeric chars in // 4-char blocks. The `validator` enforces the // mod-97 checksum on the unmasked value. pattern: '**** **** **** **** **** **** **** **', validator: PATTERN_VALIDATOR.IBAN }
- [BUILT_IN_PATTERN.SIRET]: { pattern: '### ### ### #####', validator: null }
- [BUILT_IN_PATTERN.CREDIT_CARD]: { pattern: '#### #### #### ####', validator: PATTERN_VALIDATOR.LUHN }
- [BUILT_IN_PATTERN.DATE_ISO]: { pattern: '####-##-##', validator: PATTERN_VALIDATOR.DATE_ISO }
- [BUILT_IN_PATTERN.DATE_FR]: { pattern: '##/##/####', validator: PATTERN_VALIDATOR.DATE_FR }
- [BUILT_IN_PATTERN.DATE_US]: { pattern: '##/##/####', validator: PATTERN_VALIDATOR.DATE_US }
- [BUILT_IN_PATTERN.TIME]: { pattern: '##:##', validator: null }
- [BUILT_IN_PATTERN.TIME_12H]: { pattern: '##:## AA', validator: null }
- [BUILT_IN_PATTERN.POSTCODE_FR]: { pattern: '#####', validator: null }
- [BUILT_IN_PATTERN.POSTCODE_US]: { pattern: '#####', validator: null }
Ecosystem
Used by
Composables and components that consume this constant.
OrigamMask
useMask
Usage
Examples
Ready-to-paste code snippets using this constant.
Using a built-in mask preset