Home

Awesome

banner

@tsparticles/preact

npm npm GitHub Sponsors

Official tsParticles Preact component

Slack Discord Telegram

tsParticles Product Hunt <a href="https://www.buymeacoffee.com/matteobruni"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a beer&emoji=🍺&slug=matteobruni&button_colour=5F7FFF&font_colour=ffffff&font_family=Arial&outline_colour=000000&coffee_colour=FFDD00"></a>

Installation

npm install @tsparticles/preact

or

yarn add @tsparticles/preact

How to use

Code

Examples:

Remote url

import Particles, { initParticlesEngine } from "@tsparticles/preact";
import { loadFull } from "tsparticles";

class App extends Component {
    state = {
        particlesInitialized: false,
    };

    constructor(props) {
        super(props);

        this.particlesLoaded = this.particlesLoaded.bind(this);

        initParticlesEngine(async engine => {
            // you can initialize the tsParticles instance (main) here, adding custom shapes or presets
            // this loads the tsparticles package bundle, it's the easiest method for getting everything ready
            // starting from v2 you can add only the features you need reducing the bundle size
            await loadFull(engine);
        }).then(() => {
            this.setState({
                particlesInitialized: true,
            });
        });
    }

    particlesLoaded(container) {
        console.log(container);
    }

    render() {
        if (!this.state.particlesInitialized) {
            return null;
        }

        return (
            <Particles id="tsparticles" url="http://foo.bar/particles.json" particlesLoaded={this.particlesLoaded} />
        );
    }
}

Options object

import Particles from "@tsparticles/preact";
import { loadFull } from "tsparticles";

class App extends Component {
    state = {
        particlesInitialized: false,
    };

    constructor(props) {
        super(props);

        this.particlesLoaded = this.particlesLoaded.bind(this);

        initParticlesEngine(async engine => {
            // you can initialize the tsParticles instance (main) here, adding custom shapes or presets
            // this loads the tsparticles package bundle, it's the easiest method for getting everything ready
            // starting from v2 you can add only the features you need reducing the bundle size
            await loadFull(engine);
        }).then(() => {
            this.setState({
                particlesInitialized: true,
            });
        });
    }

    particlesLoaded(container) {
        console.log(container);
    }

    render() {
        if (!this.state.particlesInitialized) {
            return null;
        }

        return (
            <Particles
                id="tsparticles"
                particlesLoaded={this.particlesLoaded}
                options={{
                    background: {
                        color: {
                            value: "#0d47a1",
                        },
                    },
                    fpsLimit: 120,
                    interactivity: {
                        events: {
                            onClick: {
                                enable: true,
                                mode: "push",
                            },
                            onHover: {
                                enable: true,
                                mode: "repulse",
                            },
                            resize: true,
                        },
                        modes: {
                            push: {
                                quantity: 4,
                            },
                            repulse: {
                                distance: 200,
                                duration: 0.4,
                            },
                        },
                    },
                    particles: {
                        color: {
                            value: "#ffffff",
                        },
                        links: {
                            color: "#ffffff",
                            distance: 150,
                            enable: true,
                            opacity: 0.5,
                            width: 1,
                        },
                        move: {
                            direction: "none",
                            enable: true,
                            outModes: {
                                default: "bounce",
                            },
                            random: false,
                            speed: 6,
                            straight: false,
                        },
                        number: {
                            density: {
                                enable: true,
                                area: 800,
                            },
                            value: 80,
                        },
                        opacity: {
                            value: 0.5,
                        },
                        shape: {
                            type: "circle",
                        },
                        size: {
                            value: { min: 1, max: 5 },
                        },
                    },
                    detectRetina: true,
                }}
            />
        );
    }
}

Props

PropTypeDefinition
idstringThe id of the element.
widthstringThe width of the canvas.
heightstringThe height of the canvas.
optionsobjectThe options of the particles instance.
urlstringThe remote options url, called using an AJAX request
styleobjectThe style of the canvas element.
classNamestringThe class name of the canvas wrapper.
canvasClassNamestringthe class name of the canvas.
containerobjectThe instance of the particles container
particlesLoadedfunctionThis function is called when particles are correctly loaded in canvas, the current container is the parameter and you can customize it here

Find your parameters configuration here.

Demos

The demo website is here

https://particles.js.org

There's also a CodePen collection actively maintained and updated here

https://codepen.io/collection/DPOage