# Shared React Components
[![npm version](https://badge.fury.io/js/%40prague-digi%2Freact-shared-components.svg)](https://badge.fury.io/js/%40prague-digi%2Freact-shared-components)
[![build status](https://gitlab.com/moneta-digi/react-shared-components/badges/master/build.svg)](https://gitlab.com/moneta-digi/react-shared-components/commits/master)
[![coverage report](https://gitlab.com/moneta-digi/react-shared-components/badges/master/coverage.svg)](https://gitlab.com/moneta-digi/react-shared-components/commits/master)
[![monthly downloads](https://img.shields.io/npm/dm/@prague-digi/react-shared-components.svg)](https://www.npmjs.com/package/@prague-digi/react-shared-components)
[![total downloads](https://img.shields.io/npm/dt/@prague-digi/react-shared-components.svg)](https://www.npmjs.com/package/@prague-digi/react-shared-components)
## Getting started
### Documentation
Documentation for components can be found on link that you can find in our **Slack** channel

Link to pinned post:
<https://moneta-digital.slack.com/archives/C5HFRJRHB/p1499623364471497>
***
### Localhost development
You can run your own documentation simply by running those commands:

    yarn
    yarn start

It will start local documentation server on port **6060**

#### List of available yarn commands:

- `yarn build` : build documentation package
- `yarn health-check` : run **ESlint** check and **Jest** coverage report
- `yarn lint` : run **ESlint** check
- `yarn lint:fix` : run autofix for **ESlint**
- `yarn newclean` : do a clean installation
- `yarn start` : run **Styleguidist** server
- `yarn test` : run **Jest** in watcher mode
- `yarn test:coverage` : generate test coverage report

***
### List of available components
- `<Select />` - Required props: name, label and options
- `<Radio />` - Required props: name, label and options
- `<Checkbox />` - Required props: name and label
- `<Input />` - Required props: name and label
- `<Slider />` - Required props: name and label
- `muiTheme` - Needs to be passed to to `<MuiThemeProvider muiTheme={muiTheme}>`
- `<FormDebug />` - Receives values and errors which are being returned by redux-form
- `<Button />`
- `<Loader />`
