react-native-gradient-buttons-improved/README.md

React Native gradient buttons for your next project

# React Native Gradient Buttons [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Gradient%20buttons%20in%20%40reactnative%20by%20%40thomaswang%20with%201%20line%20of%20code%21%20Instructions%20here%3A%20https%3A%2F%2Fgithub.com%2Fzivlakmilos%2Freact-native-gradient-buttons-improved)

[![Version](https://img.shields.io/npm/v/react-native-gradient-buttons-improved)](https://www.npmjs.com/package/react-native-gradient-buttons-improved)
[![Platform](https://img.shields.io/badge/platform-ios%2Fandroid-blue.svg)](https://facebook.github.io/react-native/)
[![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/thomaswang/react-native-gradient-buttons/blob/master/LICENSE)

Lightweight, customizable and haptic Gradient Buttons for React Native.

<img src="./Examples.png" alt="Examples" width="250">

Supports press and long press actions.

## Requirements

Requires React and React Native.

For pure React Native projects you must install [react-native-unimodules](https://github.com/unimodules/react-native-unimodules) as part of [Expo's bare workflow](https://docs.expo.io/versions/latest/introduction/managed-vs-bare/#bare-workflow).

## Installation

```
yarn add react-native-gradient-buttons
# or
npm install --save react-native-gradient-buttons-improved
```

## Usage

```
# ES6 import
import GradientButton from 'react-native-gradient-buttons-improved';
```

## Props

- `style`: `ViewStyle`
  - No default
  - options: any styles you want to apply to the button
- `text`: `String`
  - No default
  - options: any string
- `textStyle`: `TextSyle`
  - default: `{}`
  - options: any styles you want to apply to the text
- `gradientBegin`: `String`
  - default: `'#00d2ff'`
  - options: Any hex, rgb, or color
- `gradientEnd`: `String`
  - default: `'#3a47d5'`
  - options: Any hex, rgb, or color
- `gradientDirection`: `String`
  - default: `'horizontal'`
  - options: `'horizontal'`, `'vertical'`, `'diagonal'`
- `height`: `Number` or `String` (for %)
  - default: `75`
  - options: any number
- `width`: `Number` or `String` (for %)
  - No default
  - options: any number
- `radius`: `Number`
  - default: `50`
  - options: any number
- `impact`: `Boolean`
  - default: `false`
  - options: `true` or `false`
- `impactStyle`: `String`
  - default: `'Heavy'`
  - options: `'Heavy'`, `'Medium'`, `'Light'`
- `onPressAction`: `Function`
  - No default
  - options: any function you want to pass to the Gradient Button
- `onLongPressAction`: `Function`
  - No default
  - options: any function you want to pass to the Gradient Button
- `disabled`: `Boolean`
  - default: false
- `disabledGradientBegin`: `String`
  - default: `'#D3D3D3'`
  - options: Any hex, rgb, or color
- `disabledGradientEnd`: `String`
  - default: `'#696969'`
  - options: Any hex, rgb, or color

**Design+Code Specific Gradient Props**

- purpleViolet
- violetPink
- pinkDarkGreen
- blueViolet
- blueMarine
- deepBlue

## Examples

```
  <View style={{flex: 1, justifyContent: 'space-evenly', alignItems: 'center', marginVertical: 24}}>
    <GradientButton
      style={{ marginVertical: 8 }}
      text="Gradient Button #1"
      textStyle={{ fontSize: 20 }}
      gradientBegin="#874f00"
      gradientEnd="#f5ba57"
      gradientDirection="diagonal"
      height={60}
      width={300}
      radius={15}
      impact
      impactStyle='Light'
      onPressAction={() => alert('You pressed me!')}
    />

    <GradientButton
      style={{ marginVertical: 8 }}
      textStyle={{ fontSize: 20 }}
      gradientBegin="#874f00"
      gradientEnd="#f5ba57"
      gradientDirection="diagonal"
      height={60}
      width={300}
      radius={15}
      impact
      impactStyle='Light'
      onPressAction={() => alert('You pressed me!')}
      onLongPressAction={() => alert('You long pressed me!')}
    >
      Gradient Button #2
    </GradientButton>

    <GradientButton text="Purple Violet" width='90%' purpleViolet impact />
    <GradientButton text="Violet Pink" width='90%' violetPink impact />
    <GradientButton text="Pink Dark Green" width='90%' pinkDarkGreen impact />
    <GradientButton text="Blue Violet" width='90%' blueViolet impact />
    <GradientButton text="Blue Marine" width='90%' blueMarine impact />
    <GradientButton text="Deep Blue" width='90%' deepBlue impact />
    <GradientButton text="Disabled" width='90%' disabled impact />
  </View>
```