ambient-cbg-ts/README.md

A React.js webpage backgrounds created using the HTML5 Canvas API and jwagner's Simplex Noise library

## React Ambient Canvas Backgrounds

The main project [crnacura/ambient-cbg](https://yuriylisovskiy.github.io/ambient-cbg).

I just re-implemented the components to make it support typescript and work with the latest reactjs.

---

git s

This module is React adaptation of [crnacura/AmbientCanvasBackgrounds](https://github.com/crnacura/AmbientCanvasBackgrounds) project with additional code refactoring and improvements.

Check the [example](https://yuriylisovskiy.github.io/ambient-cbg) web application.

### Installation
```bash
$ npm install ambient-cbg-ts
```

OR using yarn
```bash
$ yarn add ambient-cbg-ts
```

### Usage
Example:
```js
// App.js
import React, {Component} from 'react';
import './App.css';

import {Pipline} from 'ambient-cbg-ts'

class App extends Component {
    render() {
        return (
            <div className="App">
                <Pipline/>
                <h1>Hello, World!</h1>
            </div>
        );
    }
}

export default App;
```

### API
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| backgroundColor | Change the canvas background-color. | string (e.g. #fff) | hsla(150,80%,1%,1) | 1.1.0 |
| styles | Change the canvas default styles. | CSSProperties | {....} | 1.1.0 |


### License
This project is licensed under the conditions of the MIT software license, see [LICENSE](LICENSE) file for more details.