# react-native-switch-with-icons

> A simple switch component with icons in the thumb.

Latest version **3.0.1** (published 2022-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-native-switch-with-icons
pnpm add react-native-switch-with-icons
yarn add react-native-switch-with-icons
bun add react-native-switch-with-icons
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2022-08-18 |
| First published | 2020-10-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 275.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 15 |
| Author | Fernando Silva |
| Maintainers | fernando.silva |
| Keywords | react-native, react-native-component |

## Links

- npm: https://www.npmjs.com/package/react-native-switch-with-icons
- Repository: https://github.com/fernando-silva-dev/react-native-switch-with-icons
- Homepage: https://github.com/fernando-silva-dev/react-native-switch-with-icons#readme
- Issues: https://github.com/fernando-silva-dev/react-native-switch-with-icons/issues
- npm.io page: https://npm.io/package/react-native-switch-with-icons

## Recent versions

- 3.0.1 (latest) — 2022-08-18
- 3.0.0 — 2022-08-15
- 2.0.1 — 2020-10-30
- 2.0.0 — 2020-10-30
- 1.1.0 — 2020-10-30
- 1.0.2 — 2020-10-29
- 1.0.1 — 2020-10-26
- 1.0.0 — 2020-10-25

## README

# react-native-switch-with-icons

A simple switch component with icons in the thumb.

![GitHub branch checks state](https://github.com/fernando-silva-dev/react-native-switch-with-icons/actions/workflows/node.js.yml/badge.svg)
<a href="https://www.npmjs.com/package/react-native-switch-with-icons" target="_blank"><img alt="npm" src="https://img.shields.io/npm/v/react-native-switch-with-icons"></a>
![npm](https://img.shields.io/npm/dw/react-native-switch-with-icons)
![GitHub Repo stars](https://img.shields.io/github/stars/fernando-silva-dev/react-native-switch-with-icons)
![GitHub issues](https://img.shields.io/github/issues/fernando-silva-dev/react-native-switch-with-icons)

## Example

![example](./assets/example.gif)

## Installation

```bash
npm i react-native-switch-with-icons
```

or

```bash
yarn add react-native-switch-with-icons
```

## Usage

```js
import SwitchWithIcons from "react-native-switch-with-icons";

const [darkMode, setDarkMode] = useState(false);

<SwitchWithIcons
  value={darkMode}
  onValueChange={setDarkMode}
/>
```

## Properties

| Prop               | Description                          | Type     | Default                                                   |
| :----------------- | :----------------------------------- | :------- | :-------------------------------------------------------- |
| value              | The value to be represented          | Boolean  | false                                                     |
| disabled           | Defines if user can interact         | Boolean  | false                                                     |
| noIcon             | Sets the visibility of the icon      | Boolean  | false                                                     |
| onValueChange      | Change value callback                | Function | -                                                         |
| icon               | The icons to be displayed            | Object   | {true: SwitchOn, false: SwitchOff}                        |
| trackColor         | The colors of the track              | Object   | {true: "rgb(144, 195, 240)", false: "rgb(187, 194, 204)"} |
| thumbColor         | The colors of the thumb              | Object   | {true: "rgb(52, 149, 235)", false: "rgb(255, 255, 255)"}  |
| iconColor          | The colors of the icons              | Object   | {true: "#FFFFFF", false: "#9499AD"}                       |
| disabledThumbColor | The color of the thumb when disabled | String   | "#9499AD"                                                 |
| disabledTrackColor | The color of the track when disabled | String   | "#BCBFC9"                                                 |
| disabledIconColor  | The color of the icon when disabled  | String   | "#FFFFFF"                                                 |
| animationDuration  | The duration of the animation        | Number   | 200                                                       |

## Contributing

Pull requests are welcome.

---
_Source: https://npm.io/package/react-native-switch-with-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._