carbon-react/lib/utils/validations/inclusion/inclusion.js

A library of reusable React components and an interface for easily building user interfaces based on Flux.

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _validations = require('./../../helpers/validations');

var _validations2 = _interopRequireDefault(_validations);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

/**
 * An Inclusion Validator object.
 *
 * == How to use this validator ==
 *
 * Import the validator into your component:
 *
 *  `import InclusionValidator from 'utils/validations/inclusion'`
 *
 * Validate the value is included in the list, pass an array in the param allowedValues:
 *
 *  e.g.
 *
 *  `<TextArea validations={ [new InclusionValidator({ allowedValues: ['foo', 'bar'] })] }/>`
 *
 * would validate that the value of the text field is either 'foo' or 'bar'.
 *
 *
 * @constructor InclusionValidator
 */
var InclusionValidator =

/**
 * @method constructor
 * @param {Object} params
 */
function InclusionValidator() {
  var _this = this;

  var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};

  _classCallCheck(this, InclusionValidator);

  this.validate = function (value) {
    return _this.allowedValues.indexOf(value) !== -1;
  };

  this.message = function () {
    return _validations2.default.validationMessage(_this.customMessage, 'errors.messages.inclusion');
  };

  this.allowedValues = params.allowedValues || [];

  /**
   * An optional custom validation message.
   *
   * @property customMessage
   * @type {String}
   */
  this.customMessage = params.customMessage;
}

/**
 * This will validate the given value, and return a valid status.
 *
 * @method validate
 * @param {String} value to check presence
 * @return {Boolean} true if value is valid
 */


/**
 * This is the message returned when this validation fails.
 *
 * @method message
 * @return {String} the error message to display
 */
;

exports.default = InclusionValidator;