# react-form-flow

Manage your form through a small structure for capturing and validating form data.

[![NPM](https://img.shields.io/npm/v/react-form-flow.svg?style=flat-square) ![NPM](https://img.shields.io/npm/dm/react-form-flow.svg?style=flat-square)](https://www.npmjs.com/package/react-form-flow)
[![Build Status](https://github.com/daniloster/react-form-flow/actions/workflows/nodejs.yml/badge.svg)](https://github.com/daniloster/react-form-flow/actions/workflows/nodejs.yml)
[![minizipped size](https://flat.badgen.net/bundlephobia/minzip/react-form-flow)](https://bundlephobia.com/result?p=react-form-flow@latest)

## Documentation

- [Getting started](https://codeinbox.me/react-form-flow/?path=/docs/docs-getting-started--page)
- [Recipes: Schema Builder](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-schema-builder--schema-builder)
- [Recipes: Factory for validations](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-validations--page)
- [Recipes: useFormFlowItem](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-useformflowitem--page)
- [Recipes/Elements: Input Field](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-input--page)
- [Recipes/Elements: Checkbox Field](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-checkbox--page)
- [Recipes/Elements: Dropdown Field](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-dropdown--page)
- [Recipes/Elements: Radio Field](https://codeinbox.me/react-form-flow/?path=/docs/docs-recipes-radio--page)
- [Code Sandbox](https://codesandbox.io/s/pensive-paper-sgykr)

## Contributions rules

- Changes must be approved;
- Changes must have tests passing on github actions;
- Changes must have coverage of 95% on github actions for: statements, branches, functions and lines;
- Last commit message must have attribute `[release] [major|minor|patch]`;

## Current core dependencies versions

- node: `^14.16.0`
- yarn (version may be check at `package.json`)

## Peer dependencies

```js static
"mutation-helper": "^1.0.0",
"prop-types": "^15.7.2",
"react": "^16.8.4"
```

## Consuming

Installing with npm

```bash
npm install react-form-flow
```

Installing with yarn

```bash
yarn add react-form-flow
```