https://github.com/gfazioli/react-toggle

A React UI Component to display an awesome Toggle Button control
https://github.com/gfazioli/react-toggle

component docz react reactjs toggle toggle-buttons toggle-switches typescript

Last synced: 1 day ago
JSON representation

A React UI Component to display an awesome Toggle Button control

• Host: GitHub
• URL: https://github.com/gfazioli/react-toggle
• Owner: gfazioli
• License: mit
• Created: 2018-10-30T11:20:09.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-02T08:19:45.000Z (2 months ago)
• Last Synced: 2024-09-02T10:07:17.524Z (about 1 month ago)
• Topics: component, docz, react, reactjs, toggle, toggle-buttons, toggle-switches, typescript
• Language: TypeScript
• Homepage: https://gfazioli.github.io/react-toggle/
• Size: 13 MB
• Stars: 17
• Watchers: 3
• Forks: 9
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 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 Interactive 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 ;

}

```

## Documentation

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

## Contributing

Thanks for any of your contributions 👏.

## Bugs 🐛

Use the GitHub issues.

## License

MIT Licensed. Copyright (c) Giovambattista Fazioli 2019.