zipCode validator

Validate zip codes in different countries

Options

Using with form field
The HTML attributes are used to set the validator options via the Declarative plugin
(* denotes a required option)
NameHTML attributeTypeDescription
country *data-fv-zip-code___countryString or FunctionAn ISO-3166 country code
messagedata-fv-zip-code___messageStringThe error message
If you want to support custom formats of a zipCode number, you should use the Transformer plugin.
The validator supports the following countries:
CountryCountry code
United StatesUS
AustriaAT
BulgariaBG
BrazilBR
CanadaCA
Czech RepublicCZ
DenmarkDK
FranceFR
GermanyDE
IndiaIN
ItalyIT
IrelandIE
MoroccoMA
NetherlandsNL
PolandPL
PortugalPT
RomaniaRO
RussiaRU
SingaporeSG
SlovakiaSK
SpainES
SwedenSE
SwitzerlandCH
United KingdomGB
US zipcode
This validator supports 4 digits US zipcode. If you want a valid US zipcode to be 5 digits exactly, use the regexp validator:
<script>
document.addEventListener('DOMContentLoaded', function (e) {
FormValidation.formValidation(document.getElementById('demoForm'), {
fields: {
postcode: {
validators: {
regexp: {
regexp: /^\d{5}$/,
message: 'The US zip code must contain 5 digits',
},
},
},
},
});
});
</script>
Using with ES6 module
// You might need to change the importing path
import zipCode from 'formvalidation/dist/es6/validators/zipCode';
const result = zipCode().validate({
value: ...,
options: {
// Can be a string or a function returns a string
country: ...,
message: ...,
},
});
/*
result is an object of
{
valid: true or false,
message: The error message
}
*/

Basic example

zipCode validator

Using country option with different value

In the example above, the value of country select box must be the country code as following.
<select class="input-reset ba b--black-20 pa2 mb2 db w-100" name="country">
<option value="US">United States</option>
<option value="AT">Austria</option>
<option value="BG">Bulgaria</option>
<option value="BR">Brazil</option>
<option value="CA">Canada</option>
<option value="CZ">Czech Republic</option>
...
</select>
In the case that the value attribute of option can't exactly be the country code, instead, be a country name for example:
<select class="input-reset ba b--black-20 pa2 mb2 db w-100" name="country">
<option value="United States">United States</option>
<option value="Austria">Austria</option>
<option value="Bulgaria">Bulgaria</option>
<option value="Brazil">Brazil</option>
<option value="Canada">Canada</option>
<option value="Czech Republic">Czech Republic</option>
...
</select>
Then we need to set the country option as a callback function returning a country code based on the selected name:
<script>
document.addEventListener('DOMContentLoaded', function(e) {
const form = document.getElementById('demoForm');
const fv = FormValidation.formValidation(
form,
{
fields: {
postalCode: {
validators: {
zipCode: {
country: function() {
// Map the country names to the code
const map = {
'United States': 'US',
'Austria': 'AT',
'Bulgaria': 'BG',
'Brazil': 'BR',
'Canada': 'CA',
'Czech Republic': 'CZ',
'Denmark': 'DK',
'French': 'FR',
'Germany': 'DE',
'India': 'IN',
'Italy': 'IT',
'Morocco': 'MA',
'Netherlands': 'NL',
'Poland': 'PL',
'Portugal': 'PT',
'Romania': 'RO',
'Russia': 'RU',
'Singapore': 'SG',
'Slovakia': 'SK',
'Spain': 'ES',
'Sweden': 'SE',
'Switzerland': 'CH',
'United Kingdom': 'GB'
};
// Get the selected country
const country = form.querySelector('[name="country"]').value;
// Return the country code based on selected name
return (country == '') ? '' : (map[country] || '');
},
message: 'The value is not a valid postal code'
}
}
},
},
plugins: {
...,
},
}
);
form.querySelector('[name="country"]').addEventListener('change', function() {
// Revalidate the postal code field whenever user changes the country
fv.revalidateField('postalCode');
});
});
</script>
This case happens when you can't control the value of country select box which might be generated by a back-end side or third party.

ES6 Module Example

The following snippet shows how to use the zipCode validator with ES6 module:
// You might need to change the importing path
import zipCode from 'formvalidation/dist/es6/validators/zipCode';
const res1 = zipCode().validate({
value: '12345',
options: {
country: 'US',
message: 'The value is not a valid zipcode',
},
});
// res1.valid === true
const res2 = zipCode().validate({
value: '12345',
options: {
country: 'AT',
message: 'The value is not a valid zipcode',
},
});
// res2.valid === false

See also

Changelog

v1.9.0
  • The validator throws an exception if the message option isn't defined
v1.6.0
  • Fixed an issue that the country option isn't passed to the placeholder message