## Synopsis

WakeOnWeb-Toolkit is a collection of React elements developed by WakeOnWeb, for use in WakeOnWeb projects.

## Elements

The Toolkit is an ever-growing collection of useful elements.

### GenericForm

A component to handle dynamic form properties. It contains, and exposes, many different input
types.

### GenericTable

A component to render tabular data, with optional pagination (see below).

#### Pagination

A component that offers configurable pagination.

## Installation

To install the Toolkit, you need to have access to the WakeOnWeb private repository. Once logged
in, just do:

- using npm

```
npm install -S wakeonweb-toolkit
```

- using yarn

```
yarn add wakeonweb-toolkit
```

## Usage

Once installed, just import the components in your code:

- using `require` in ES5:

```
var toolkit = require('wakeonweb-toolkit');
var GenericForm = toolkit.GenericForm;
var GenericTable = toolkit.GenericTable;
```

- using `import` in ES6:

```
import { GenericForm, GenericTable } from 'wakeonweb-toolkit';
```

## Compatibility

A polyfill is needed to support CustomEvent in IE 9/10/11
For exemple: https://github.com/krambuhl/custom-event-polyfill

## API Reference (WIP)

Please check the source code, and types, to know more about the API.

## Contributors

Let people know how they can dive into the project, include important links to things like issue trackers, irc, twitter accounts if applicable.

## License

MIT.

