greaterThan validator
Check if the value is greater than or equals to given number
Options
Using with form field
(* denotes a required option)
Name | HTML attribute | Type | Description |
---|
inclusive | data-fv-greater-than___inclusive | Boolean | Can be true (default) or false . |
| | | If true , the input value must be greater than or equal to the comparison one. |
| | | If false , the input value must be greater than the comparison one. |
message | data-fv-greater-than___message | String | The error message |
min * | data-fv-greater-than___min | Float | The number to make a comparison to |
If you want the value to support custom format, such as a comma for thousand separator, you should use the
Transformer plugin.
Using the ES6 module
import { greaterThan } from '/vendors/@form-validation/cjs/validator-greater-than';
const result = greaterThan().validate({
value: ...,
options: {
inclusive: ...,
message: ...,
min: ...,
},
});
Using the npm package
- Install the validator package:
$ npm install @form-validation/validator-greater-than
- Use the
greaterThan
validator:
import { greaterThan } from '@form-validation/validator-greater-than';
const result = greaterThan().validate({
value: ...,
options: {
inclusive: ...,
message: ...,
min: ...,
},
});
Basic example
NPM package example
The following snippet shows how to use the greaterThan validator with the npm package:
import { greaterThan } from '@form-validation/validator-greater-than';
const res1 = greaterThan().validate({
value: 20,
options: {
message: 'The value has to be greater than 18',
min: 18,
},
});
const res2 = greaterThan().validate({
value: 18,
options: {
inclusive: false,
message: 'The value has to be greater than 18',
min: 18,
},
});
See also
Changelog
- The validator doesn't work properly if the
message
property isn't defined
- Fixed an issue that the
min
option isn't passed to the placeholder message