npm package: @paraboly/react-native-switch-fab
Description: Animated & Fully Customizable Switch Floating Action Button for React Native by Paraboly
Author: Kuray
Latest version: 0.0.2

<img alt="React Native SwitchFab by Paraboly" src="assets/logo.png" width="1050"/>

[![Battle Tested ✅](https://img.shields.io/badge/-Battle--Tested%20%E2%9C%85-03666e?style=for-the-badge)](https://github.com/WrathChaos/@paraboly/react-native-switch-fab)

[![Animated & Fully Customizable Switch Floating Action Button for React Native by Paraboly](https://img.shields.io/badge/-Animated%20%26%20Fully%20Customizable%20Switch%20Floating%20Action%20Button%20for%20React%20Native%20by%20Paraboly-lightgrey?style=for-the-badge)](https://github.com/WrathChaos/@paraboly/react-native-switch-fab)

[![npm version](https://img.shields.io/npm/v/@paraboly/react-native-switch-fab.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/react-native-switch-fab)
[![npm](https://img.shields.io/npm/dt/@paraboly/react-native-switch-fab.svg?style=for-the-badge)](https://www.npmjs.com/package/@paraboly/react-native-switch-fab)
![Platform - Android and iOS](https://img.shields.io/badge/platform-Android%20%7C%20iOS-blue.svg?style=for-the-badge)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=for-the-badge)](https://github.com/prettier/prettier)

<p align="center">
  <img alt="React Native SwitchFab by Paraboly"
        src="assets/Screenshots/example.png" />
  <img alt="React Native SwitchFab by Paraboly"
        src="assets/Screenshots/example.gif" />
</p>

# Installation

Add the dependency:

```ruby
npm i @paraboly/react-native-switch-fab
```

## Peer Dependencies

###### IMPORTANT! You need install them

```js
"react": ">= 16.x.x",
"react-native": ">= 0.55.x",
"react-native-androw": ">= 0.0.34",
"react-native-dynamic-vector-icons": ">= 0.2.1",
"react-native-material-ripple": ">= 0.9.1",
"react-native-vector-icons": ">= 6.6.0"
```

# Usage

## Import

```js
import SwitchFab from "@paraboly/react-native-switch-fab";
```

## Usage

### Basic Usage

```jsx
<SwitchFab />
```

### Advanced Usage

Check the example for the multiple & advanced usage

```jsx
<SwitchFab
  name="atom"
  type="Fontisto"
  rippleColor="transparent"
  activeBGColor="#00B1D2FF"
  inactiveBGColor="#FDDB27FF"
/>
```

# Configuration - Props

| Property          |      Type      |                    Default                    | Description                                                                                              |
| ----------------- | :------------: | :-------------------------------------------: | -------------------------------------------------------------------------------------------------------- |
| width             | string/number  |                      50                       | change the width of the button                                                                           |
| height            | string/number  |                      50                       | change the height of the button                                                                          |
| borderRadius      |     number     |                      25                       | change the border radius of the button                                                                   |
| IconComponent     | Icon Component | Icon (from react-native-dynamic-vector-icons) | set your own Icon component it can be your own MyIcon component or react-native-vector-icons or anything |
| isActive          |    boolean     |                     false                     | set the default active button                                                                            |
| onPress           |    function    |                   undefined                   | set your own logic for onPress it has callback for (isActive)                                            |
| animationDuration |     number     |                      750                      | change the animation duration for background color transition                                            |
| shadowColor       |     color      |                    #757575                    | change the button's shadow color                                                                         |
| activeBGColor     |     color      |                    #757575                    | change the button's active background color                                                              |
| inactiveBGColor   |     color      |                    #fdfdfd                    | change the button's inactive background color                                                            |
| activeIconColor   |     color      |                    #757575                    | change the button's active icon color                                                                    |
| inactiveIconColor |     color      |                    #fdfdfd                    | change the button's inactive icon color                                                                  |
| animationDuration |     number     |                      750                      | change the animation duration for background color transition                                            |
| animationDuration |     number     |                      750                      | change the animation duration for background color transition                                            |

## Future Plans

- [x] ~~LICENSE~~
- [x] ~~New Screenshots~~
- [ ] Write an article about the lib on Medium

## Author

FreakyCoder, kurayogun@gmail.com

## License

React Native SwitchFab by Paraboly is available under the MIT license. See the LICENSE file for more info.