react-behave/README.md

A library of behaviors for React applications.

<!--
  THIS FILE WAS GENERATED!
  Don't make any changes in it, update README-template.md instead.
  If you still need to make changes in this file, remove this header so it won't be overridden.
-->

# react-behave

[![npm version latest](https://img.shields.io/npm/v/react-behave/latest.svg?colorB=success&style=flat-square)](https://www.npmjs.com/package/react-behave)
[![npm version next](https://img.shields.io/npm/v/react-behave/next.svg?colorB=blue&style=flat-square)](https://www.npmjs.com/package/react-behave/v/1.1.1)

A library of behaviors for React applications.

⚠️ **Warning:** The current master can represent unreleased features of the library.
[See lastest release](https://github.com/simonrelet/react-behave/tree/1.1.1).

## ...Of what?

...Of behavioral components.

The components of this library will be focused on functionality and only contain very basic and fully customisable UI.

Here, we focus on **how components work** rather than how they look.

This means:

- You can use any other component library for the UI like [Material UI](https://material-ui.com/), [React Bootstrap](https://react-bootstrap.github.io/), [Blueprint](http://blueprintjs.com/), [Element React](https://eleme.github.io/element-react/#/en-US/quick-start), etc.
- Or write your own from scratch.
- You can use CSS-in-JS, CSS modules or basic CSS.
- There is no `<Button />` component.

## Installation

### npm

```sh
npm install --save react-behave
```

### yarn

```sh
yarn add react-behave
```

## Documentation

The documentation of each component can be found [here](https://github.com/simonrelet/react-behave/tree/1.1.1/docs).

---

_This project was inspired by [react-autocomplete](https://github.com/reactjs/react-autocomplete)._