react-toggle-component/README.md

A React UI Component to display an awesome Toggle Button control

# Overview

![version](https://img.shields.io/npm/v/react-toggle-component.svg)
![license](https://img.shields.io/npm/l/react-toggle-component.svg)
![issues](https://img.shields.io/github/issues/gfazioli/react-toggle.svg)
![type](https://img.shields.io/npm/types/react-toggle-component.svg)
![last-commit](https://img.shields.io/github/last-commit/gfazioli/react-toggle.svg)
![npm](https://img.shields.io/npm/dm/react-toggle-component.svg)

This component is designed to render an awesome switch/toggle component.

[![Edit React Toggle](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/01nxypo6zl?autoresize=1&fontsize=14&hidenavigation=1&view=preview)

## New in v2.0.x

* Use Typescript
* Use React Hooks
* New [Documentation and Intercative Playground](https://gfazioli.github.io/react-toggle/)
* Removed the import styles
* New props

## Upgrade Guide

If you're using the previous version 1.x, have a look at [Upgrade to 2.0 from 1.x](https://gfazioli.github.io/react-toggle) before upgrade

## Installation

You can use either **npm**

```bash
npm i react-toggle-component
```

or **yarn**

```bash
yarn add react-toggle-component
```

## Basic Usage

First of all, remember to import the component.

```jsx
import React from "react"

import {Toggle} from "react-toggle-component"

function Application() {

  return <Toggle name="toggle-1" />;

}
```

## Documentation

See the complete [documentation and intercative playground](https://gfazioli.github.io/react-toggle/)


## Contributing

Thanks for any your contribute 👏.

## Bugs 🐛

Use the GitHub issues.

## License

MIT Licensed. Copyright (c) Giovambattista Fazioli 2019.