https://github.com/kokilaw/simple-react-switch
A simple toggle switch component for ReactJS. Check the demo on https://kokilaw.github.io/simple-react-switch.
https://github.com/kokilaw/simple-react-switch
component-library reactjs toggle toggle-buttons toggle-switches
Last synced: about 2 months ago
JSON representation
A simple toggle switch component for ReactJS. Check the demo on https://kokilaw.github.io/simple-react-switch.
- Host: GitHub
- URL: https://github.com/kokilaw/simple-react-switch
- Owner: kokilaw
- License: mit
- Created: 2018-12-07T07:03:27.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-09T06:30:46.000Z (over 7 years ago)
- Last Synced: 2025-09-14T12:34:22.425Z (9 months ago)
- Topics: component-library, reactjs, toggle, toggle-buttons, toggle-switches
- Language: JavaScript
- Homepage:
- Size: 3.83 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# simple-react-switch
[](https://www.npmjs.com/package/simple-react-switch) [](https://github.com/styled-components/styled-components)
A simple toggle switch component for ReactJS inspired from this cool [switch animation](https://dribbble.com/shots/5429846-Switcher-XLIV) by [Oleg Frolov](https://dribbble.com/Volorf).
Referred most of the styling from [this codepen.io project](https://codepen.io/aaroniker/pen/oaQdQZ) by [Aaron Iker](https://codepen.io/aaroniker/).
Demo is available here.
## Installation
```bash
npm install simple-react-switch
```
## Usage
```javascript
import React, { Component } from "react";
import { HorizontalSwitch } from "simple-react-switch";
class App extends Component {
handleChange = (isChecked, key, event) => {
// Take action...
};
render() {
return (
);
}
}
```
## API
| Prop | Type | Default | Description |
| ------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| defaultChecked | bool | false | If true, the switch is set to checked. If false, it is not checked. |
| id | string | **Required** | Set as an attribute to the embedded checkbox. This is useful for the associated label, which can point to the id in its htmlFor attribute. |
| onStateChange _([isChecked], [id], [event])_ | func | **Required** | Invoked when the user toggles the switch. It is passed three arguments: _isChecked_, which is a boolean that describes the presumed future state of the checked prop (1), the event object (2) and the id prop (3). |
| disabled | bool | false | When disabled, the switch will no longer be interactive and its colors will be greyed out. |
| offColor | string | '#FF4651' | The switch will take on this color when it is _not_ checked. Only accepts hex-colors. |
| onColor | string | '#48EA8B' | The switch will take on this color when it is checked. Only accepts hex-colors. |
| foregroundColor | string | '#fff' | The toggle icon with animation will take on this color. Only accepts hex-colors. |
| disabledColor | string | '#D3D3D3' | The switch will take on this color when disabled. Only accepts hex-colors. |
## Available Scripts
In the project directory, you can run:
### `npm start`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the app for production to the `build` folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.