tsparticles-shape-text

matteobruni
esm deprecated
tsparticles-shape-text JS library homepage tsparticles-shape-text JS library on GitHub tsparticles-shape-text JS library on npm Download tsparticles-shape-text JS library

tsParticles text shape

Version 2.12.0 License MIT
tsparticles-shape-text JS library homepage
tsparticles-shape-text JS library on GitHub
tsparticles-shape-text JS library on npm
Download tsparticles-shape-text JS library
Keywords
front-endfrontendtsparticlesparticlesparticlecanvasjsparticlesxparticlesparticles-jsparticles.jsparticles-tsparticles.tstypescriptjavascriptanimation

banner

tsParticles Text Shape

jsDelivr npmjs npmjs GitHub Sponsors

tsParticles additional text shape.

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.shape.text.min.js file will export the function to load the shape:

loadTextShape;

Usage

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

(async () => {
  await loadTextShape(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      /* options */
      /* here you can use particles.shape.type: "text" */
    },
  });
})();

ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install tsparticles-shape-text

or

$ yarn add tsparticles-shape-text

Then you need to import it in the app, like this:

const { tsParticles } = require("tsparticles-engine");
const { loadTextShape } = require("tsparticles-shape-text");

(async () => {
  await loadTextShape(tsParticles);
})();

or

import { tsParticles } from "tsparticles-engine";
import { loadTextShape } from "tsparticles-shape-text";

(async () => {
  await loadTextShape(tsParticles);
})();