# react-boring-form

> React Boring Form handles all of the layout boilerplate (the boring part) that’s necessary when writing forms.

Latest version **1.0.0** (published 2018-10-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-boring-form
pnpm add react-boring-form
yarn add react-boring-form
bun add react-boring-form
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-10-28 |
| First published | 2018-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 50.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Eric Mantooth |
| Maintainers | erictooth |
| Keywords | react, form |

## Links

- npm: https://www.npmjs.com/package/react-boring-form
- Repository: https://github.com/erictooth/react-boring-form
- Homepage: https://github.com/erictooth/react-boring-form/blob/master/README.md
- Issues: https://github.com/erictooth/react-boring-form/issues
- npm.io page: https://npm.io/package/react-boring-form

## Dependencies (1)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2018-10-28
- 0.0.2 — 2018-10-09
- 0.0.1 — 2018-09-29

## README

# React Boring Form · [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/erictooth/react-boring-form/blob/master/LICENSE) [![npm version](https://img.shields.io/npm/v/react-boring-form.svg?style=flat-square)](https://www.npmjs.com/package/react-boring-form) ![test coverage](https://img.shields.io/badge/coverage-0%25-red.svg?style=flat-square) ![flow coverage](https://img.shields.io/badge/flow--coverage-100%25-brightgreen.svg?style=flat-square) ![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)

React Boring Form handles all of the layout boilerplate (the boring part) that’s necessary when writing forms.

## Example

Before

```jsx
<div className="form-group form-group--aligned">
    <div className="form-group-section">
        <label for="email_field" className="form-label--required">
            Email Addresses
        </label>
    </div>
    <div className="form-group-section">
        <input type="email" class="form-control" id="email_field" required />
        <span className="form-text">Separated by semicolon (;)</span>
    </div>
</div>
```

After

```jsx
<Form.Group layout="aligned" required>
    <Form.Label>Email Addresses</Form.Label>
    <Form.Control type="email" />
    <Form.Text>Separated by semicolon (;)</Form.Text>
</Form.Group>
```

## Features

-   Generates a unique `id` for the label’s `htmlFor` and input’s `id` props and links them
-   Applies `classNames` in a predictable way that reduces boilerplate and provides maximum flexibility
-   Allows usage of any custom inputs with `render` prop on `Form.Control`
-   Zero-overhead integration with form state libraries like [Formik](https://github.com/jaredpalmer/formik) and [React-Final-Form](https://github.com/final-form/react-final-form)
-   Optional tiny set of base styles that help with aligned form layouts

## `Form` Props

### `layout?: "stacked" | "aligned"`

Propagates down to all of the children `Form.Group` components. `stacked` is the default, which is to set all of the children to `display: block`. `aligned` splits all of `Form.Group`’s children into two groups: "label", and "rest" so that all of the form’s labels will align to the same width.

## `Form.Group` Props

### `required?: boolean`

Set classNames on the label to indicate a required field, and set the `required` prop on the `Form.Control`

### `disabled?: boolean`

Set classNames on the label to indicate a disabled field, and set the `disabled` prop on the `Form.Control`

## Custom Inputs

The default behavior of `Form.Control` is to configure an `input` element and render it. If you want to use something else, like a `select`, `textarea`, or a third-party library component, you can render your own component without losing the benefits of React Boring Form:

```jsx
{
    /* If the controls map to standard HTML attribute names, you can spread the props directly */
}
<Form.Control render={props => <textarea {...props} />} />;

{
    /* Otherwise, you can destructure the props and apply however is necessary */
}
<Form.Control
    render={({ className, disabled, id, required }) => (
        <SomeCustomInputComponent
            className={className}
            isDisabled={disabled}
            htmlId={id}
            isRequired={required}
        />
    )}
/>;
```

---
_Source: https://npm.io/package/react-boring-form · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._