# react-gradient-carousel

> A custom React button that plays a customizable gradient animation.

Latest version **0.1.2** (published 2018-11-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-gradient-carousel
pnpm add react-gradient-carousel
yarn add react-gradient-carousel
bun add react-gradient-carousel
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2018-11-05 |
| First published | 2018-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 9.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Philip Gingerich |
| Maintainers | philipygingerich |
| Keywords | gradient, ombre, button, react, component, custom, animation, shimmer, shiny, carousel |

## Links

- npm: https://www.npmjs.com/package/react-gradient-carousel
- Repository: https://github.com/horseeyephil/ReactGradientCarousel
- Homepage: https://github.com/horseeyephil/ReactGradientCarousel#readme
- Issues: https://github.com/horseeyephil/ReactGradientCarousel/issues
- npm.io page: https://npm.io/package/react-gradient-carousel

## 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

- 0.1.2 (latest) — 2018-11-05
- 0.1.1 — 2018-11-04
- 0.1.0 — 2018-11-04
- 0.0.1 — 2018-07-11
- 0.0.0 — 2018-07-11

## README

# React Gradient Carousel 
This package is for a custom React button component that animates an attractive gradient shimmer animation upon hover or clicking. 

The button takes an onClick prop as well as props for custom styling.

#### Props (all optional)

**onClick** : A callback to triggered on the button's click event

**colorTheme**: A color if provided to determine the button's border and main gradient theme. Note: 8-digit hex values may be provided to specify the color's alpha (opacity) value. Named color or rgba value string can also be used.

**gradientCenter**: The color to contrast in the center of the gradient

**customStyling**: An style object to provide for custom CSS attributes for the button. If not provided, a default setting will be used. Note: a borderColor property may be specified in order to overwrite the colorTheme prop and provide a border that is different than the gradient theme

**clickMode**: A number to specify the amount of iterations to animate once button is clicked. The button will no longer play on hover with this prop.

```javascript

    import GradientCarouselButton from react-gradient-carousel

    <GradientCarouselButton
        onClick = {_=>{console.log('This is a click handler!')}} 
        colorTheme = 'paleturquoise' //this is a named color
        gradientCenter = '#567bcd9e' //8 digit hex with alpha
        className = 'shiny button',
        customStyling = {
            position: 'absolute',
            borderRadius: 20,
            borderStyle: 'dotted'
        }
        clickMode = '8'
        >Here is a custom button and all its props!
    </GradientCarouselButton>
```

#### To run the demo:
Clone the repo
```
npm i 
npm run docs
```

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