https://github.com/prsn/react-native-toggle-switch
Toggle switch with label and swipe behaviour
https://github.com/prsn/react-native-toggle-switch
Last synced: 3 days ago
JSON representation
Toggle switch with label and swipe behaviour
- Host: GitHub
- URL: https://github.com/prsn/react-native-toggle-switch
- Owner: prsn
- Created: 2019-01-23T04:31:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-10T11:53:08.000Z (almost 6 years ago)
- Last Synced: 2025-11-06T11:09:55.904Z (7 months ago)
- Language: JavaScript
- Size: 1.66 MB
- Stars: 29
- Watchers: 3
- Forks: 19
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-native-toggle-switch
A toggle switch with a label inside, on top of that it animates smoothly.
*Click and drag* or just *click* it toggles either way.
# Motivation
Toggle switches are quite common in almost every application, and we have so many UX variations of it.
Based on different variations, different libraries with its own design and animation has been created by contributors.
Our UX demanded a Toggle with a label, which has both click and slide behavior.
None of the existing libraries offered this complete solution.
Some had the toggle behavior but the sliding behavior was missing, some had the swipe behavior but did not offer to have a label in it.
This library has been created to fill that gap.
# Working demo
# Install
```bash
npm install --save rn-toggle-switch
```
# Usages
```bash
import ToggleSwitch from 'rn-toggle-switch'
class Demo extends ... {
...
render() {
return (
...
{
/* your handler function... */
}}
/>
...
);
}
}
```
# Properties
| Attribute | Description |
| --- | --- |
| text.on | Text to be displayed when Switch is in Active state |
| text.off | Text to be displayed when Switch in in inactive state |
| text.activeTextColor | Active text color |
| text.inactiveTextColor | Inactive text color |
| textStyle | Any valid text style supported by RN |
| color.indicator | The color of the Slider / Indicator |
| color.active | Background color of the Switch when it is in active state |
| color.inactive | Background color of the Switch when it is in inactive state |
| color.activeBorder | The border color when Switch is in active state |
| color.inactiveBorder | The border color when Switch is in inactive state |
| active | Initial state of the Switch |
| disabled | true if the control is disabled |
| width | Width of the control |
| radius | Radius of the Slider / Indicator |
| onValueChange | The function to be called when Switch changes its states |
# Contribution
Pease feel free to create issue and raise PR :blush: