About The Project

Built With

Install

npm install --save reactjs-particle-animation
# or
yarn add reactjs-particle-animation

Usage

Check out the demo in the example folder.

import React, { Component } from 'react'

import ParticleAnimation from 'reactjs-particle-animation'

class Example extends Component {
  render () {
    return (
      <ParticleAnimation />
    )
  }
}

Props

| Property | Type | Default | Description | |:--------------|:-------------------|:--------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| | numParticles | number | 400 | Number of particles to use. | | interactive | boolean | true | Whether or not animation responds to mouse hover. | | color | object | { r: 158, g: 217, b: 249, a: 255 } | Base rgba particle color. | | background | object | { r: 255, g: 255, b: 255, a: 255 } | Background rgba color. | | lineWidth | number | 1.0 | Connecting line width. | | particleRadius| number | 1.0 | Scaling factor for particle radii. | | particleSpeed | number | 1.0 | Scaling factor for particle speed. | | ... | ... | undefined | Any other props are applied to the root canvas element. |

Note that for colors, rgba are all floating point numbers between 0 and 255 (inclusive).

Note that the canvas size will automatically be inferred based on available space via react-sizeme, so it should be really easy to use this component as a fullscreen background as in the demo.

Related

• particles.js - Older particle animation. Oddly enough, I developed this animation in Java back in 2008, though the two animations are AFAIK unrelated to each other.
• Intersection.Aggregate - Jared Tarbell's original processing work from 2004 which this animation was inspired by (e.g., visualizing the intersections between circles moving about randomly).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Ben Lewis - @benjisoft - [email protected]

Project Link: https://github.com/benjisoft/reactjs-particle-animation

Acknowledgments

• transitive-bullshit
• othneildrew
• VisiMedia

License

MIT © transitive-bullshit

This module was bootstrapped with create-react-library.

Support my OSS work by following me on twitter