Validator Specification

To be compatible with this specification, validation functions exported by a package must pass the following tests:

A validation package will usually need the user to specify a schema or validation rules in some way. One method might be to export a function, which when called with a schema will return a compatible validator function.

Each error object in the returned array must have at least these two properties:

If you create a validator package, you can choose to handle translation within it, or to output errors in one language and expect the developer to wrap your function output with another function that does the translation.

The error objects may have any other useful properties, too, but only name and message are currently used by this specification.

Example

Here is a function that returns a simple requiredness validator:

import get from 'lodash.get';

export default function getRequiredValidator(...requiredFields) {
  return (obj) => {
    const errors = [];
    requiredFields.forEach((requiredField) => {
      const value = get(obj, requiredField);
      if (value === null || value === undefined) {
        errors.push({ name: requiredField, message: `${requiredField} is required` });
      }
    });
    return errors;
  };
}

You would use it like this:

import React, { Component } from 'react';
import { Field, Form, Input } from 'reacto-form';
import getRequiredValidator from './getRequiredValidator';

const validator = getRequiredValidator('firstName', 'lastName');

class SomePage extends Component {
  render() {
    return (
      <Form validator={validator}>
        <Field label="First Name">
          <Input name="firstName" type="text" />
        </Field>
        <Field label="Last Name">
          <Input name="lastName" type="text" />
        </Field>
      </Form>
    );
  }
}