🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

react-material-ui-form-validator

Package Overview
Dependencies
Maintainers
1
Versions
66
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-material-ui-form-validator

Simple validator for forms designed with material-ui components.

0.2.0
Source
npm
Version published
Weekly downloads
12K
-14.54%
Maintainers
1
Weekly downloads
 
Created
Source

Validation component for material-ui forms

license npm version Build Status

Simple form validation component for material-ui library inspired by formsy-react

Supported types:

  • Text
  • Select
  • AutoComplete
  • Date
  • Time

Default validation rules:

  • matchRegexp
  • isEmail
  • isEmpty
  • required
  • trim
  • isNumber
  • isFloat
  • isPositive

Example

Usage

You can pass any props of field components except errorText, use errorMessages instead. Your component must provide a theme.


import React from 'react';
import RaisedButton from 'material-ui/RaisedButton';
import { ValidatorForm, TextValidator} from 'react-material-ui-form-validator';

class MyForm extends React.Component {

    constructor(props) {
        super(props);

        this.handleChange = this.handleChange.bind(this);
    }

    handleChange(event) {
        const email = event.target.value;
        this.setState({ email });
    }

    handleSubmit() {
        // your submit logic
    }

    render() {
        const { email } = this.state;
        return (
            <ValidatorForm
                ref="form"
                onSubmit={this.handleSubmit}
            >
                <TextValidator
                    floatingLabelText="Email"
                    onChange={this.handleChange}
                    name="email"
                    value={email}
                    validators={['required', 'isEmail']}
                    errorMessages={['this field is required', 'email is not valid']}
                />
                <RaisedButton type="submit" />
            </ValidatorForm>
        );
    }
}

You can add your custom rules:


import React from 'react';
import RaisedButton from 'material-ui/RaisedButton';
import { ValidatorForm, TextValidator} from 'react-material-ui-form-validator';

class ResetPasswordForm extends React.Component {

    constructor(props) {
        super(props);
        this.state = {
            user: {},
        };
        this.handleChange = this.handleChange.bind(this);
    }

    componentWillMount() {
        // custom rule will have name 'isPasswordMatch'
        ValidatorForm.addValidationRule('isPasswordMatch', (value) => {
            if (value !== this.state.user.password) {
                return false;
            }
            return true;
        });
    }

    handleChange(event) {
        const { user } = this.state;
        user[event.target.name] = event.target.value;
        this.setState({ user });
    }

    handleSubmit() {
        // your submit logic
    }

    render() {
        const { user } = this.state;

        return (
            <ValidatorForm
                onSubmit={this.handleSubmit}
            >
                <TextValidator
                    floatingLabelText="Password"
                    onChange={this.handleChange}
                    name="password"
                    type="password"
                    validators={['required']}
                    errorMessages={['this field is required']}
                    value={user.password}
                />
                <TextValidator
                    floatingLabelText="Repeat password"
                    onChange={this.handleChange}
                    name="repeatPassword"
                    type="password"
                    validators={['isPasswordMatch', 'required']}
                    errorMessages={['password mismatch', 'this field is required']}
                    value={user.repeatPassword}
                />
                <RaisedButton type="submit" />
            </ValidatorForm>
        );
    }

Currently material-ui doesn't support error messages for switches, but you can easily add your own:

import React from 'react';
import Checkbox from 'material-ui/Checkbox';
import { ValidatorComponent } from 'react-material-ui-form-validator';

export default class CustomCheckboxValidator extends ValidatorComponent {

    render() {
        const { errorMessages, validators, requiredError, ...rest } = this.props;
        const { isValid } = this.state;
        const errorMessage = !isValid && this.getErrorMessage();
        return (
            <div>
                <Checkbox {...rest} />
                {errorMessage}
            </div>
        );
    }
}

Advanced usage

API

ValidatorForm

PropRequiredTypeDefault valueDescription
onSubmittruefunctionCallback for form that fires when all validations are passed
instantValidatefalseboolfalseIf true, form will be validated after each field change. If false, form will be validated only after clicking submit button.

All validated fields (ValidatorComponent)

PropRequiredTypeDefault valueDescription
validatorsfalsearrayArray of validators. See list of default validators above.
errorMessagesfalsearrayArray of error messages. Order of messages should be the same as validators prop.
nametruestringName of input

Contributing

This component covers all my needs, but feel free to contribute.

Keywords

materia-ui

FAQs

Package last updated on 23 Mar 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts