@lemoncode/fonk-match-field-validator/README.md

Update description: This is a [fonk](https://github.com/Lemoncode/fonk) microlibrary that brings validation capabilities to validate if a field of a form matchs with another field in same form.

# fonk-match-field-validator

[![CircleCI](https://badgen.net/github/status/Lemoncode/fonk-match-field-validator/master?icon=circleci&label=circleci)](https://circleci.com/gh/Lemoncode/fonk-match-field-validator/tree/master)
[![NPM Version](https://badgen.net/npm/v/@lemoncode/fonk-match-field-validator?icon=npm&label=npm)](https://www.npmjs.com/package/@lemoncode/fonk-match-field-validator)
[![bundle-size](https://badgen.net/bundlephobia/min/@lemoncode/fonk-match-field-validator)](https://bundlephobia.com/result?p=@lemoncode/fonk-match-field-validator)

This is a [fonk](https://github.com/Lemoncode/fonk) microlibrary that brings validation capabilities to:

- Validate if a field of a form matchs with another field in same form.

How to add it to an existing form validation schema:

We have the following form model:

```javascript
const myFormValues = {
  login: 'user1',
  password: 1234,
  confirmPassword: 1234,
};
```

We can add a matchField validation to the myFormValues

```javascript
import { matchField } from '@lemoncode/fonk-match-field-validator';

const validationSchema = {
  field: {
    confirmPassword: [
      {
        validator: matchField.validator,
        customArgs: { field: 'password' },
      },
    ],
  },
};
```

You can customize the error message displayed in two ways:

- Globally, replace the default error message in all validationSchemas (e.g. porting to spanish):

```javascript
import { matchField } from '@lemoncode/fonk-match-field-validator';

matchField.setErrorMessage('El campo debe coincidir con {{field}}');
```

- Locally just override the error message for this validationSchema:

```javascript
import { matchField } from '@lemoncode/fonk-match-field-validator';

const validationSchema = {
  field: {
    confirmPassword: [
      {
        validator: matchField.validator,
        customArgs: { field: 'password' },
        message: 'The field must match with {{field}}',
      },
    ],
  },
};
```

- Even if you have a nested field:

```javascript
const myFormValues = {
  user: {
    name: 'user1',
    password: 1234,
    confirmPassword: 1234,
  },
};
```

- Overriding the message:

```javascript
import { matchField } from '@lemoncode/fonk-match-field-validator';

const validationSchema = {
  field: {
    'user.confirmPassword': [
      {
        validator: matchField.validator,
        customArgs: { field: 'user.password' },
        message: 'The field must match with {{field}}',
      },
    ],
  },
};
```

Please, refer to [fonk](https://github.com/Lemoncode/fonk) to know more.

## License

[MIT](./LICENSE)

# About Basefactor + Lemoncode

We are an innovating team of Javascript experts, passionate about turning your ideas into robust products.

[Basefactor, consultancy by Lemoncode](http://www.basefactor.com) provides consultancy and coaching services.

[Lemoncode](http://lemoncode.net/services/en/#en-home) provides training services.

For the LATAM/Spanish audience we are running an Online Front End Master degree, more info: http://lemoncode.net/master-frontend