readme.md

Mob Rules

mob-rules is an npm package for validation with mobx. It wraps validatorjs with functionality to take advantage of observers to make display of validator feedback simple and elegant.

Installation

npm install https://github.com/snap21/mob-rules.git --save

Basic Usage

The overall workflow is

• Create a MobRulesFactory
• Use the factory to create aMobRules object that contains our original data and our validation rules
• Create error containers for each field, retrieving any error with getError('foo')
• Add the onChange and onSubmit events of our form to validateOnChange and validateOnSubmit

and we're done!

This is a simple example using react

import { Component } from 'react';
import * as React from 'react';
import { observer } from 'mobx-react';
import { MobRulesFactory } from 'mob-rules';

@observer
export default class SnapForm extends Component {
    constructor() {
        const factory = new MobRulesFactory;

        // the state of the form onload. This would normally be
        // pulled from your mobx store maintaining state
        const original = {
            'demo': ''
        };

        const rules = {
            'demo': 'required'
        };

        // optional parameter to customize our error messages
        const errorMessages = {
            'demo.required' => "YOU DIDN'T ENTER :attribute"
        };

        // we can customize the attribute display names as well
        const attributeNames = {
            'demo': 'DEMOOOOOO'
        };

        this.validator = factory.make(original, rules);
        this.validator.setAttributeNames(attributeNames)
            .setErrorMessages(errorMessages);
    }

    render() {
        return (
            <form onSubmit={this.validator.validateOnSubmit} onChange={this.validator.validateOnChange}>
                <div>
                    <input type="text" name="foo" />
                    <div className="error">{this.validator.getError('foo')}</div>
                </div>

                <div>
                    <button type="submit">Submit</button>
                </div>
            </form>
        );
    }
}