# react-surfaces

> A collection of animated background gradients

Latest version **1.1.2** (published 2020-07-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-surfaces
pnpm add react-surfaces
yarn add react-surfaces
bun add react-surfaces
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2020-07-07 |
| First published | 2020-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 1 |
| Unpacked size | 99.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sem Postma |
| Maintainers | afirus |
| Keywords | react, surfaces, gradient, svg, animation |

## Links

- npm: https://www.npmjs.com/package/react-surfaces
- Repository: https://github.com/sempostma/react-surfaces
- Homepage: https://github.com/sempostma/react-surfaces#readme
- Issues: https://github.com/sempostma/react-surfaces/issues
- npm.io page: https://npm.io/package/react-surfaces

## Dependencies (1)

- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2

## 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.1.2 (latest) — 2020-07-07
- 1.1.1 — 2020-05-13
- 1.1.0 — 2020-05-09
- 1.0.0 — 2020-04-15

## README

# react-surfaces

> A collection of animated background gradients

[![NPM](https://img.shields.io/npm/v/react-surfaces.svg)](https://www.npmjs.com/package/react-surfaces) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save react-surfaces
```

## Usage

```jsx
import React, { Component } from 'react'

import Surface from 'react-surfaces'

class Example extends Component {
  render() {
    return <Surface 
      variant={2} // defaults to 1, possible values: (1-6)
      color1={'#ff0000'} // defaults to #e52421
      color2={'#0000ff'} // defaults to #0000ff
      transitionDuration={'2s'} // optional
      transitionDelay={'0s'} // optional
      transitionTimingFunction={'ease'} // optional
    />
  }
}
```

## License

MIT © [sempostma](https://github.com/sempostma)

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