between validator

Check if the input value is between (strictly or not) two given numbers

Options

Using with form field

* presents a required option. The HTML attributes are used to set the validator options via the Declarative plugin

Name HTML attribute Type Description
inclusive data-fv-between___inclusive Boolean Can be true or false. If true, the input value must be in the range strictly
max* data-fv-between___max or max Float The upper value in the range
message data-fv-between___message String The error message
min* data-fv-between___min or min Float The lower value in the range

If you use min and max attributes, please set type="range".

Using with JavaScript module


// You might need to change the importing path
import between from 'formvalidation/validators/between';

const result = between().validate({
    value: ...,
    options: {
        inclusive: ...,
        min: ...,
        max: ...,
        message: ...,
    },
});
/*
result is an object of
{
    valid: true or false,
    message: The error message
}
*/

Basic Example

The following example validates latitude and longitude values.

A valid latitude must be between -90.0 and 90.0, and valid longitude may range from -180.0 to 180.0.

Module Example

The following snippet shows how to use the between validator with JavaScript module:


// You might need to change the importing path
import between from 'formvalidation/validators/between';

const checkLatitude = between().validate({
    value: 45,
    options: {
        inclusive: true,
        min: -90,
        max: 90,
        message: 'The latitude must be between -90.0 and 90.0',
    },
});
// checkLatitude.valid === true

const checkLongitude = between().validate({
    value: 200,
    options: {
        inclusive: true,
        min: -180,
        max: 180,
        message: 'The latitude must be between -180.0 and 180.0',
    },
});
// checkLongitude.valid === false

Related validators

The following validators are similar to this one and might be useful to you.

Name Description
greaterThan Check if the value is greater than or equals to given number
lessThan Check if the value is less than or equals to given number