# rn-toggle

> A customizable toggle switch for React Native that works on Android and iOS without any extra installation steps

Latest version **1.0.10** (published 2020-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install rn-toggle
pnpm add rn-toggle
yarn add rn-toggle
bun add rn-toggle
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.10 |
| Published | 2020-08-29 |
| First published | 2020-08-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Abuda Khaminkaew |
| Maintainers | abuda |
| Keywords | React, native, animated, toggle, switch |

## Links

- npm: https://www.npmjs.com/package/rn-toggle
- Repository: https://github.com/Abuda/rn-toggle
- Homepage: https://github.com/Abuda/rn-toggle#readme
- Issues: https://github.com/Abuda/rn-toggle/issues
- npm.io page: https://npm.io/package/rn-toggle

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.10 (latest) — 2020-08-29
- 1.0.5 — 2020-08-29
- 1.0.4 — 2020-08-27
- 1.0.3 — 2020-08-27
- 1.0.2 — 2020-08-27
- 1.0.1 — 2020-08-27
- 1.0.0 — 2020-08-27

## README

### RN-Toggle
A customizable toggle switch for React Native that works on Android and iOS without any extra installation steps.

###  Demo
![20200829_025333_edited](https://user-images.githubusercontent.com/1588378/91626159-92801f80-e9a4-11ea-870f-24b6432479b4.gif)

###  Installation:
`$ npm install rn-toggle`

###  Basic Usage:
```javascript
import Toggle from 'rn-toggle';
....
const [isActive, setIsActive] = useState(false);
....
<Toggle isActive={isActive} toggle={() => setIsActive(value => !value)} />
```

###  Customized Usage:
```javascript
import Toggle from 'rn-toggle';
....
const [isActive, setIsActive] = useState(false);
....
<Toggle
	width={70}
	isActive={isActive}
	toggle={() => setIsActive(value => !value)}
	activeColor='#000000'
	text={isActive ? 'on ' : 'off'}
	textStyle={{ color: isActive ? '#FFFFFF' : '#666666' }}
	cursorColor='#FF0000'
	inactiveColor='#FFFFFF'
	borderColor='#FF0000'
/>
```
###  Props
Name | Type | Required | Default | Description
------------- | ------------- | ------------- | ------------- | -------------
containerStyle | Object | no | {} | Styling for the outermost component
isActive |	Boolean | no | false | Value that determines whether the toggle is switched on or off
toggle | Function | no | () => null | Action to perform when the toggle switch is pressed
width | Integer | no | 50 | Sets the width of the toggle switch
duration | Integer | no | 150 | Time that the animation takes in milliseconds
textStyle | Object | no | {} | Styling for the toggle text
text | String | no | null | Text to display on the toggle
disabled | Boolean | no | false | Value that determines whether the toggle switch is disabled or not
vertical | Boolean | no | false | Value that determines whether the toggle switch is vertical or horizontal
cursorColor | Hexadecimal String | no | '#FFFFFF' | Sets the color of the cursor
borderColor | Hexadecimal String | no | '#EEEEEE' | Sets the border color of the toggle switch
activeColor | Hexadecimal String | no | '#4CD862' | Sets the color of the toggle switch when active
inactiveColor | Hexadecimal String | no | '#DDDDDD' | Sets the color of the toggle switch when inactive

###  Contributing
Pull requests are always welcome! Feel free to open a new GitHub issue for any changes that can be made.
###  License
[MIT](https://github.com/Abuda/rn-toggle/blob/master/LICENSE)
###  Authors
+ [Abuda](https://github.com/Abuda)

---
_Source: https://npm.io/package/rn-toggle · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._