@tsparticles/plugin-export-json

tsParticles Export JSON Plugin

tsParticles plugin for adding the export json support.

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call the package loader function(s) before tsParticles.load(...)
3. Apply the package options in your tsParticles.load(...) config

How to use it

CDN / Vanilla JS / jQuery

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

Including the tsparticles.plugin.export.json.min.js file will export the function to load the plugin:

loadExportJSONPlugin

Usage

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

(async () => {
  await loadExportJSONPlugin();

  await tsParticles.load({
    id: "tsparticles",
    options: {/* options */},
  });
})();

ESM / CommonJS

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

$ npm install @tsparticles/plugin-export-json

or

$ yarn add @tsparticles/plugin-export-json

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

const { tsParticles } = require("@tsparticles/engine");
const { loadExportJSONPlugin } = require("@tsparticles/plugin-export-json");

(async () => {
  await loadExportJSONPlugin();
})();

or

import { tsParticles } from "@tsparticles/engine";
import { loadExportJSONPlugin } from "@tsparticles/plugin-export-json";

(async () => {
  await loadExportJSONPlugin();
})();

Option mapping

• This package primarily extends runtime behavior or rendering and may not expose a single dedicated root options key.
• Use the usage example in this README and combine with the nearest options section in the docs.

Common pitfalls

• Calling tsParticles.load(...) before loadExportJSONPlugin(...)
• Verify required peer packages before enabling advanced options
• Change one option group at a time to isolate regressions quickly

Related docs

• All packages catalog: https://github.com/tsparticles/tsparticles
• Main docs: https://particles.js.org/docs/