Validators • Angular
Validator that requires the control's value to be greater than or equal to the provided number.
Validator that requires the control's value to be less than or equal to the provided number.
Validator that requires the control have a non-empty value.
Validator that requires the control's value be true. This validator is commonly used for required checkboxes.
Validator that requires the control's value pass an email validation test.
Tests the value using a regular expression pattern suitable for common use cases. The pattern is based on the definition of a valid email address in the WHATWG HTML specification with some enhancements to incorporate more RFC rules (such as rules related to domain names and the lengths of different parts of the address).
The differences from the WHATWG version include:
- Disallow
local-part(the part before the@symbol) to begin or end with a period (.). - Disallow
local-partto be longer than 64 characters. - Disallow the whole address to be longer than 254 characters.
If this pattern does not satisfy your business needs, you can use Validators.pattern() to
validate the value against a different pattern.
Validator that requires the number of items in the control's value to be greater than or equal
to the provided minimum length. This validator is also provided by default if you use
the HTML5 minlength attribute. Note that the minLength validator is intended to be used
only for types that have a numeric length or size property, such as strings, arrays or
sets. The minLength validator logic is also not invoked for values when their length or
size property is 0 (for example in case of an empty string or an empty array), to support
optional controls. You can use the standard required validator if empty values should not be
considered valid.
Usage notes
Validate that the field has a minimum of 3 characters
const control = new FormControl('ng', Validators.minLength(3));console.log(control.errors); // {minlength: {requiredLength: 3, actualLength: 2}}
Validator that requires the number of items in the control's value to be less than or equal
to the provided maximum length. This validator is also provided by default if you use
the HTML5 maxlength attribute. Note that the maxLength validator is intended to be used
only for types that have a numeric length or size property, such as strings, arrays or
sets.
Usage notes
Validate that the field has maximum of 5 characters
const control = new FormControl('Angular', Validators.maxLength(5));console.log(control.errors); // {maxlength: {requiredLength: 5, actualLength: 7}}
Validator that requires the control's value to match a regex pattern. This validator is also
provided by default if you use the HTML5 pattern attribute.
@parampatternstring | RegExp
A regular expression to be used as is to test the values, or a string.
If a string is passed, the ^ character is prepended and the $ character is
appended to the provided string (if not already present), and the resulting regular
expression is used to test the values.
Usage notes
Validate that the field only contains letters or spaces
const control = new FormControl('1', Validators.pattern('[a-zA-Z ]*'));console.log(control.errors); // {pattern: {requiredPattern: '^[a-zA-Z ]*$', actualValue: '1'}}
<input pattern="[a-zA-Z ]*">
Pattern matching with the global or sticky flag
RegExp objects created with the g or y flags that are passed into Validators.pattern
can produce different results on the same input when validations are run consecutively. This is
due to how the behavior of RegExp.prototype.test is
specified in ECMA-262
(RegExp preserves the index of the last match when the global or sticky flag is used).
Due to this behavior, it is recommended that when using
Validators.pattern you do not pass in a RegExp object with either the global or sticky
flag enabled.
Validator that performs no operation.
Compose multiple validators into a single function that returns the union of the individual error maps for the provided control.
@returnsnull
Compose multiple async validators into a single function that returns the union of the individual error objects for the provided control.