stringLength validator
Validate the length of a string
Options
Using with form field
(* denotes a required option)
Name | HTML attribute | Type | Description |
---|
max * | data-fv-string-length___max or maxlength | Number | The maximum length |
message | data-fv-string-length___message | String | The error message |
min * | data-fv-string-length___min or minlength | Number | The minimum length |
utf8Bytes | data-fv-string-length___utf8-bytes | Boolean | Evaluate string length in UTF-8 bytes. Default to false |
trim | data-fv-string-length___trim | Boolean | Indicate the length will be calculated after trimming the value or not. Default to false |
At least one of min
and max
options is required.
Using with ES6 module
import stringLength from 'formvalidation/dist/es6/validators/stringLength';
const result = stringLength().validate({
value: ...,
options: {
'case': ...,
message: ...,
},
});
Basic example
In the following form, the Full name and Bio fields must be less than 50 and 200 characters respectively.
HTML5 Example
When the
Declarative plugin is used, the stringLength validator will be turned on automatically if the input uses HTML 5
maxlength
or
minlength
attribute.
ES6 Module Example
The following snippet shows how to use the stringLength validator with ES6 module:
import stringLength from 'formvalidation/dist/es6/validators/stringLength';
const res1 = stringLength().validate({
value: '123456',
options: {
max: 10,
message: 'The input has to be less than 11 characters',
},
});
const res2 = stringLength().validate({
value: '1234567890♥',
options: {
min: 5,
max: 10,
message: 'The input has to be between 5 and 10 characters long',
},
});
See also
Changelog
- The stringLength validator doesn't increase or decrease the number of characters in the error message
- Fixed an issue that the
max
and min
options aren't passed to the placeholder message