Skip to content

Instalação

Escolha seu caminho

CenárioComando
Início rápido (recomendado)pnpm add @tsparticles/engine @tsparticles/slim
Configuração mínimapnpm add @tsparticles/engine @tsparticles/basic
Conjunto completo de funcionalidadespnpm add @tsparticles/engine tsparticles
Tudo no repositóriopnpm add @tsparticles/engine @tsparticles/all
Apenas confetepnpm add @tsparticles/confetti
Apenas fogos de artifíciopnpm add @tsparticles/fireworks
Fundo de partículaspnpm add @tsparticles/particles
Efeito ribbonpnpm add @tsparticles/ribbons

Importante: @tsparticles/engine sozinho não desenha nada. Você deve sempre adicionar um bundle (para carregar formas e animações) ou plugins individuais. Consulte o guia de bundles.

npm

bash
# engine + slim (recomendado para a maioria dos projetos)
npm install @tsparticles/engine @tsparticles/slim

# engine + basic (mínimo)
npm install @tsparticles/engine @tsparticles/basic

# engine + full (tsparticles)
npm install @tsparticles/engine tsparticles

# engine + all
npm install @tsparticles/engine @tsparticles/all

# Bundles com API dedicada (sem engine explícito)
npm install @tsparticles/confetti
npm install @tsparticles/fireworks
npm install @tsparticles/particles
npm install @tsparticles/ribbons

yarn

bash
yarn add @tsparticles/engine @tsparticles/slim
# ... mesmo padrão para outros bundles

pnpm

bash
pnpm add @tsparticles/engine @tsparticles/slim
# ... mesmo padrão para outros bundles

CDN (script tags)

Todos os pacotes estão disponíveis no jsDelivr, unpkg e cdnjs.

jsDelivr

BundleURL
Enginehttps://cdn.jsdelivr.net/npm/@tsparticles/engine@4/tsparticles.engine.min.js
Basichttps://cdn.jsdelivr.net/npm/@tsparticles/basic@4/tsparticles.basic.bundle.min.js
Slimhttps://cdn.jsdelivr.net/npm/@tsparticles/slim@4/tsparticles.slim.bundle.min.js
Full (tsparticles)https://cdn.jsdelivr.net/npm/tsparticles@4/tsparticles.bundle.min.js
Allhttps://cdn.jsdelivr.net/npm/@tsparticles/all@4/tsparticles.all.bundle.min.js
Confettihttps://cdn.jsdelivr.net/npm/@tsparticles/confetti@4/tsparticles.confetti.bundle.min.js
Fireworkshttps://cdn.jsdelivr.net/npm/@tsparticles/fireworks@4/tsparticles.fireworks.bundle.min.js
Particleshttps://cdn.jsdelivr.net/npm/@tsparticles/particles@4/tsparticles.particles.bundle.min.js
Ribbonshttps://cdn.jsdelivr.net/npm/@tsparticles/ribbons@4/tsparticles.ribbons.bundle.min.js
Compatibilidade particles.jshttps://cdn.jsdelivr.net/npm/@tsparticles/pjs@4/tsparticles.pjs.min.js

unpkg

Mesma estrutura: https://unpkg.com/{nome-do-pacote}@{versão}/{arquivo}

Exemplo: https://unpkg.com/@tsparticles/slim@4/tsparticles.slim.bundle.min.js

cdnjs

https://cdnjs.com/libraries/tsparticles

Exemplos de importação

Com bundler (importação ES module)

ts
// Engine + loader do bundle
import { tsParticles } from "@tsparticles/engine";
import { loadSlim } from "@tsparticles/slim";

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

Com CommonJS (require)

ts
const { tsParticles } = require("@tsparticles/engine");
const { loadSlim } = require("@tsparticles/slim");

(async () => {
  await loadSlim(tsParticles);
  await tsParticles.load({ id: "tsparticles", options: { ... } });
})();

Com CDN (script tag)

html
<!-- 1. Engine -->
<script src="https://cdn.jsdelivr.net/npm/@tsparticles/engine@4/tsparticles.engine.min.js"></script>
<!-- 2. Bundle (expõe loadBasic/loadSlim/loadFull/loadAll globalmente) -->
<script src="https://cdn.jsdelivr.net/npm/@tsparticles/slim@4/tsparticles.slim.bundle.min.js"></script>
<!-- 3. Seu script -->
<script>
  (async () => {
    await loadSlim(tsParticles); // registrar funcionalidades
    await tsParticles.load({
      id: "tsparticles",
      options: {
        particles: {
          number: { value: 60 },
          move: { enable: true },
        },
      },
    });
  })();
</script>

Com bundles de API dedicada:

html
<script src="https://cdn.jsdelivr.net/npm/@tsparticles/confetti@4/tsparticles.confetti.bundle.min.js"></script>
<script>
  confetti({ particleCount: 100, spread: 70 });
</script>

Páginas relacionadas