- Install
@tsparticles/configsand@tsparticles/engine - Import one config preset (for example
configs.basic) - Pass that config to
tsParticles.load(...)
npm install --save-dev @tsparticles/configsor
yarn add --dev @tsparticles/configsor
pnpm add --save-dev @tsparticles/configs<script src="https://cdn.jsdelivr.net/npm/@tsparticles/engine/tsparticles.engine.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@tsparticles/configs/tsparticles.configs.min.js"></script>import { tsParticles } from "@tsparticles/engine"; // not needed with CDN
import * as configs from "@tsparticles/configs"; // not needed with CDN
(async () => {
await tsParticles.load({ id: "tsparticles", options: configs.basic });
})();import { tsParticles } from "@tsparticles/engine";
import * as configs from "@tsparticles/configs";
(async () => {
await tsParticles.load({ id: "tsparticles", options: configs.basic });
})();Some configs need plugins to work, they are not installed with this library.
This library contains only the config files, the plugins must be installed separately.
- Using a config that requires plugins without loading those plugins first
- Assuming this package bundles runtime plugins (it only exports config objects)
- Mixing config objects from different versions without checking option compatibility
- Main docs: https://particles.js.org/docs/
- Root options guide: https://github.com/tsparticles/tsparticles/blob/main/markdown/Options.md
- Repository README: https://github.com/tsparticles/tsparticles/blob/main/README.md
