react-cherryblossom/README.md

A Cherryblossom Effect component for React 🌸

# react-cherryblossom


A Cherryblossom component for React.

**Live Demo :** [https://shuhei-tagawa.github.io/react-cherryblossom/](https://shuhei-tagawa.github.io/react-cherryblossom/)

## Getting Started
### Installation

```
$ npm install --save react-cherryblossom
```

## Usage
```javascript
import React, { Component } from 'react';
import Cherryblossom from 'react-cherryblossom';

class MyComponent extends Component {
	render(){
		return (
			<Cherryblossom />
		)
	}
}
```

## Default Options

Argument | Type | Default Value | Description
:---: | :---: | :---: | ---
**amount** | *Number* | *80* | Amount of cherryblossom petals.
**size** | *Number* | *12* | Size of cherryblossom petals (px).
**velocity** | *Number* | *1.5* | Vertical speed for X.
**windforce** | *Number* | *2* | Horizontal wind power.
**rolling** | *Number* | *2* | Rolling speed for Y.
**zindex** | *Number* | *auto* | Specifies the stack order of the canvas layer.