Node's Perpetuum Mobile

    tsparticles
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.6 • Public • Published

    banner

    tsParticles Full Bundle

    jsDelivr npmjs npmjs

    tsParticles full bundle loads all the v1 features to a tsparticles-engine instance.

    Included Packages

    How to use it

    CDN / Vanilla JS / jQuery

    The CDN/Vanilla version JS has two different files:

    • One is a bundle file with all the scripts included in a single file
    • One is a file including just the loadFull function to load the tsParticles full preset, all dependencies must be included manually

    Bundle

    Including the tsparticles.bundle.min.js file will work exactly like v1, you can start using the tsParticles instance in the same way.

    This is the easiest usage, since it's a single file with the same v1 features.

    All new features will be added as external packages, this bundle is recommended for migrating from v1 easily.

    Not Bundle

    This installation requires more work since all dependencies must be included in the page. Some lines above are all specified in the Included Packages section.

    A note about tsparticles-slim can be made: it's not mandatory to include all of its dependencies, the slim bundle file is enough, and if this is done the tsparticles-engine is not needed, since it's already bundled in the slim bundle.

    Usage

    Once the scripts are loaded you can set up tsParticles like this:

    loadFull(tsParticles); // not needed if using the bundle script, required for any other installation
    
    tsParticles.load("tsparticles", {
      /* options */
    });

    React.js / Preact / Inferno

    The syntax for React.js, Preact and Inferno is the same.

    This sample uses the class component syntax, but you can use hooks as well (if the library supports it).

    Class Components

    import React from "react";
    import Particles from "react-tsparticles";
    import type { Engine } from "tsparticles-engine";
    import { loadFull } from "tsparticles";
    
    export class ParticlesContainer extends PureComponent<unknown> {
      // this customizes the component tsParticles installation
      async customInit(engine: Engine): Promise<void> {
        // this adds the bundle to tsParticles
        await loadFull(engine);
      }
    
      render() {
        const options = {
          /* custom options */
        };
    
        return <Particles options={options} init={this.customInit} />;
      }
    }

    Hooks / Functional Components

    import React, { useCallback } from "react";
    import Particles from "react-tsparticles";
    import type { Engine } from "tsparticles-engine";
    import { loadFull } from "tsparticles";
    
    export function ParticlesContainer(props: unknown) {
      // this customizes the component tsParticles installation
      const customInit = useCallback(async (engine: Engine) => {
        // this adds the bundle to tsParticles
        await loadFull(engine);
      });
    
      const options = {
        /* custom options */
      };
    
      return <Particles options={options} init={this.customInit} />;
    }

    Vue (2.x and 3.x)

    The syntax for Vue.js 2.x and 3.x is the same

    <Particles id="tsparticles" :particlesInit="particlesInit" url="http://foo.bar/particles.json" />
    async function particlesInit(engine: Engine): Promise<void> {
      await loadFull(engine);
    }

    Angular

    <ng-particles
      [id]="id"
      [options]="particlesOptions"
      (particlesLoaded)="particlesLoaded($event)"
      [particlesInit]="particlesInit"
    ></ng-particles>
    async function particlesInit(engine: Engine): Promise<void> {
      await loadFull(engine);
    }

    Svelte

    
    <Particles
            id="tsparticles"
            url="http://foo.bar/particles.json"
            on:particlesInit="{onParticlesInit}"
    />
    
    let onParticlesInit = (engine) => {
      loadFull(engine);
    };

    Install

    npm i tsparticles

    DownloadsWeekly Downloads

    35,876

    Version

    2.0.6

    License

    MIT

    Unpacked Size

    1.1 MB

    Total Files

    18

    Last publish

    Collaborators

    • ar3s