Skip to content

YidirK/react-smoke-effect

Repository files navigation

react-smoke-effect

A simple React library to add A Fog / Smoke effect

NPM NPM JavaScript Style Guide

Install

npm install --save react-smoke-effect

OR

yarn add react-smoke-effect

Usage

import React from 'react'
import  SmokeScene  from "react-smoke-effect"
import SmokeImage from "./assets/smoke.png"

const App = () => {
  return (
    <div>
      <SmokeScene
        backgroundColor="#D3A863"
        particleImage={SmokeImage} //  particleImage="/path/to/image.png"
        particleCount={20}
        baseOpacity={0.4}
      />
      // or for default settings
      <SmokeScene
        particleImage={SmokeImage} />
    </div>
  )
}

export default App

Props

Prop Type Default Description
backgroundColor string / hex 'transparent' Background color.
particleCount number 10 Number of particles to use.
baseOpacity number 0.45 Opacity of particles.
particleImage string (default smoke) Image of particles

License

MIT © YidirK Powered by Hergol

This module was bootstrapped with create-react-library.

About

A simple React library to add A Fog / Smoke effect

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published