[Из песочницы] Валидация сложных форм React. Часть 1
Для начала надо установить компонент react-validation-boo, предполагаю что с react вы знакомы и как настроить знаете.
npm install react-validation-boo
Чтобы много не болтать, сразу приведу небольшой пример кода.
import React, {Component} from 'react';
import {connect, Form, Input, logger} from 'react-validation-boo';
class MyForm extends Component {
sendForm = (event) => {
event.preventDefault();
if(this.props.vBoo.isValid()) {
console.log('Получаем введённые значения и отправляем их на сервер', this.props.vBoo.getValues());
} else {
console.log('Выведем в консоль ошибки', this.props.vBoo.getErrors());
}
};
getError = (name) => {
return this.props.vBoo.hasError(name) ? {this.props.vBoo.getError(name)} : '';
};
render() {
return
}
}
export default connect({
rules: () => (
[
['name', 'required'],
]
),
middleware: logger
})(MyForm);
Давайте разберём этот код.
Начнём с функции connect, в него мы передаём наши правила валидации и другие дополнительные параметры. Вызвав этот метод мы получаем новую функцию в которую передаём наш компонент (MyForm), чтобы он получил в props необходимые методы работы с валидацией форм.
В функции render нашего компонента мы возвращаем компонент Form который соединяем с правилами валидации connect={this.props.connect}. Эта необходимая конструкция для того чтобы Form знал как валидировать вложенные компоненты.
поле ввода которое мы будем проверять, правила проверки мы передали connect в свойстве rules. В нашем случае это name не должно быть пустым (required).
Также мы в connect передали middleware: logger, для того чтобы в консоли увидеть как происходит валидация.
В props нашего компонента мы получили набор функций:
- vBoo.isValid () — возвращает true, если все компоненты ввода прошли валидацию
- vBoo.hasError (name) — возвращает true, если компонент со свойством name не валидин
- vBoo.getError (name) — для компонента со свойством name, возвращает текст ошибки
Теперь постепенно будем усложнять, для начала в connect передадим язык, для того чтобы можно было менять правила валидации в зависимости от языка, а также добавим дополнительные поля и правила валидации.
import React, {Component} from 'react';
import {connect, Form, Input, InputCheckbox} from 'react-validation-boo';
class MyForm extends Component {
sendForm = (event) => {
event.preventDefault();
if(this.props.vBoo.isValid()) {
console.log('Получаем введённые значения и отправляем их на сервер', this.props.vBoo.getValues());
} else {
console.log('Выведем в консоль ошибки', this.props.vBoo.getErrors());
}
};
getError = (name) => {
return this.props.vBoo.hasError(name) ? {this.props.vBoo.getError(name)} : '';
};
render() {
return
}
}
export default connect({
rules: (lang) => {
let rules = [
[
['name', 'email'],
'required',
{
error: '%name% не должно быть пустым'
}
],
['email', 'email']
];
rules.push(['remember', lang === 'ru' ? 'required': 'valid']);
return rules;
},
labels: (lang) => ({
name: 'Имя',
email: 'Электронная почта',
remember: 'Запомнить'
}),
lang: 'ru'
})(MyForm);
В данном примере чекбокс remember на русском язык обязательно должен быть установлен required, а на других он всегда валиден valid.
Также мы передали в connect функцию labels (lang), которая возвращает название полей в читаемом виде.
В props вашего компонента, есть функция getLabel (name), которая возвращает значение переданное функцией labels или если такого значения нет, то возвращает name.
Базовые компоненты vBoo
Form, Input, InputRadio, InputCheckbox, Select, Textarea.
import React, {Component} from 'react';
import {connect, Form, Input, Select, InputRadio, InputCheckbox, Textarea} from 'react-validation-boo';
class MyForm extends Component {
sendForm = (event) => {
event.preventDefault();
if(this.props.vBoo.isValid()) {
console.log('Получаем введённые значения и отправляем их на сервер', this.props.vBoo.getValues());
} else {
console.log('Выведем в консоль ошибки', this.props.vBoo.getErrors());
}
};
getError = (name) => {
return this.props.vBoo.hasError(name) ? {this.props.vBoo.getError(name)} : '';
};
render() {
return
}
}
export default connect({
rules: () => ([
[
['name', 'email'],
'required',
{
error: '%name% не должно быть пустым'
}
],
['email', 'email'],
[['gender', 'familyStatus', 'comment', 'remember'], 'valid']
]),
labels: () => ({
name: 'Имя',
email: 'Электронная почта',
gender: 'Пол',
familyStatus: 'Семейное положение',
comment: 'Комментарий',
remember: 'Запомнить'
}),
lang: 'ru'
})(MyForm);
Правила валидации
Давайте рассмотрим как писать свои правила валидации.
Для того чтобы написать правило необходимо создать класс, который будет унаследован от класса validator.
import {validator} from 'react-validation-boo';
class myValidator extends validator {
/**
* name - имя поля, если есть label то передастся он
* value - текущее значение поля
* params - параметры которые были переданны 3-м агрументом в правила валидации(rules)
*/
validate(name, value, params) {
let lang = this.getLang();
let pattern = /^\d+$/;
if(!pattern.test(value)) {
let error = params.error || 'Ошибка для поля %name% со значением %value%';
error = error.replace('%name%', name);
error = error.replace('%value%', value);
this.addError(error);
}
}
}
export default myValidator;
Теперь подключим наш валидатор к форме.
import myValidator from 'path/myValidator';
// ...
export default connect({
rules: () => ([
[
'name',
'required',
{
error: '%name% не должно быть пустым'
}
],
[
'name',
'myValidator',
{
error: 'это и будет params.error'
}
]
]),
labels: () => ({
name: 'Имя'
}),
validators: {
myValidator
},
lang: 'ru'
})(MyForm);
Чтобы каждый раз не прописывать все ваши правила валидации, создаём отдельный файл, где они будут прописаны и подключаем его validators: `import 'file-validation'`. А если для этой формы есть какие-то особые правила, то validators: Object.assign ({}, `import 'file-validation'`, {…})
Сценарии
Рассмотрим случаи когда нам необходимо менять правила валидации в зависимости от действий производимых на форме.
По умолчанию у нас сценарий, который называется default, в правилах мы можем прописать при каком сценарии проводить данную валидацию.
Если сценарий не указан, то валидация будет выполняться для всех сценариев.
rules = () => ([
[
'name',
'required',
{
error: '%name% не должно быть пустым'
}
],
[
'name',
'myValidator',
{
scenario: ['default', 'scenario1']
}
],
[
'email',
'email',
{
scenario: 'scenario1'
}
]
])
Через свойство props нашего компонента передаются функции:
- vBoo.setScenario (scenario) — устанавливает сценарий scenario, может быть как строка так и массив, если у нас активны сразу несколько сценариев
- vBoo.getScenario () — возвращает текущий сценарий или массив сценариев
- vBoo.hasScenario (name) — показывает установлен ли сейчас данный сценарий, name строка
Давайте в нашей форме добавим объект scenaries, в котором будем хранить все возможные сценарии, true сценарий активен, false нет.
А также функции addScenaries и deleteScenaries, которые будут добавлять и удалять сценарии.
Если у нас «семейное положение» выбрано «сожительство» или «брак», то добавляем поле комментарий и естественно это поле надо валидировать только в этом случае, сценарий 'scenario-married'.
Если у нас чекбокс «Дополнительно» выставлен, то добавляем дополнительные поля, которые станут обязательны для заполнения, сценарий 'scenario-addition'.
import React, {Component} from 'react';
import {connect, Form, Input, Select, InputRadio, InputCheckbox, Textarea} from 'react-validation-boo';
class MyForm extends Component {
constructor() {
super();
this.scenaries = {
'scenario-married': false,
'scenario-addition': false
}
}
changeScenaries(addScenaries = [], deleteScenaries = []) {
addScenaries.forEach(item => this.scenaries[item] = true);
deleteScenaries.forEach(item => this.scenaries[item] = false);
let scenario = Object.keys(this.scenaries)
.reduce((result, item) => this.scenaries[item]? result.concat(item): result, []);
this.props.vBoo.setScenario(scenario);
}
addScenaries = (m = []) => this.changeScenaries(m, []);
deleteScenaries = (m = []) => this.changeScenaries([], m);
sendForm = (event) => {
event.preventDefault();
if(this.props.vBoo.isValid()) {
console.log('Получаем введённые значения и отправляем их на сервер', this.props.vBoo.getValues());
} else {
console.log('Выведем в консоль ошибки', this.props.vBoo.getErrors());
}
};
getError = (name) => {
return this.props.vBoo.hasError(name) ? {this.props.vBoo.getError(name)} : '';
};
changeFamilyStatus = (event) => {
let val = event.target.value;
if(val !== '1') {
this.addScenaries(['scenario-married'])
} else {
this.deleteScenaries(['scenario-married']);
}
};
changeAddition = (event) => {
let check = event.target.checked;
if(check) {
this.addScenaries(['scenario-addition'])
} else {
this.deleteScenaries(['scenario-addition']);
}
};
getCommentContent() {
if(this.props.vBoo.hasScenario('scenario-married')) {
return (
{this.getError('comment')}
);
}
return '';
}
getAdditionContent() {
if(this.props.vBoo.hasScenario('scenario-addition')) {
return (
{this.getError('place')}
);
}
return '';
}
render() {
return
}
}
export default connect({
rules: () => ([
[
['name', 'gender', 'familyStatus', 'email'],
'required',
{
error: '%name% не должно быть пустым'
}
],
['email', 'email'],
[
'comment',
'required',
{
scenario: 'scenario-married'
}
],
['addition', 'valid'],
[
'place',
'required',
{
scenario: 'scenario-addition'
}
],
]),
labels: () => ({
name: 'Имя',
email: 'Электронная почта',
gender: 'Пол',
familyStatus: 'Семейное положение',
comment: 'Комментарий',
addition: 'Дополнительно',
place: 'Место'
}),
lang: 'ru'
})(MyForm);
Чтобы не делать статью очень большой, продолжу в следующей, где напишу как создавать свои компоненты (например календарь или inputSearch) и их валидировать, как связать с redux и другое.
