Skip to content

Dooblr/react-interactive-particle-background

Repository files navigation

React Interactive Particle Background

This is a React-friendly adaptation of cojdev's interactive particle network background from his codepen: https://codepen.io/cojdev/pen/mRRbQw

npm package: https://www.npmjs.com/package/react-interactive-particle-background



To run:

npm i

npm run dev


The package includes two core files: ParticleBackground.tsx and ParticleBackground.scss.

ParticleBackground.tsx provides an fixed-positioned background with a negative Z-index, allowing it to function as the background of your page, regardless of where it is placed within your JSX. For best results, it's recommended to insert it at the top of your component tree or whatever page you want it in, similar to a toast notification component.

If the background is not displaying, ensure that the html, body, and any container elements have their background set to transparent. This will prevent any conflicts and ensure the particle background renders correctly.


Usage

import { ParticleBackground } from 'react-interactive-particle-background';

const App = () => (
  <ParticleBackground
    particleColor="255, 255, 255"
    particleSpeed={2.0}
    attractionStrength={1}
    deflection={true}
    canvasZIndex={-1000}
    particleOpacity={0.8}
    bokehEffect={false} // TODO: FIX
    style={{}}
  />
);

export default App;

About

A React adaptation of cojdev's interactive particle network

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published