Integración con Vue 3

El paquete @tsparticles/vue3 proporciona un componente nativo de Vue 3 y un sistema de plugins para tsParticles. Esta guía cubre todo, desde la configuración básica hasta patrones avanzados como el cambio dinámico de temas y presets personalizados.

---

Instalación

npm install @tsparticles/vue3 @tsparticles/engine

Opcionalmente instala un preset o el paquete completo:

# Paquete completo (todas las funcionalidades)
npm install tsparticles

# Presets específicos
npm install @tsparticles/preset-confetti
npm install @tsparticles/preset-fireworks
npm install @tsparticles/preset-snow
npm install @tsparticles/preset-stars

# Configuraciones de utilidad
npm install @tsparticles/configs

---

Uso Básico

Registra el plugin en el punto de entrada de tu aplicación, luego usa el componente <vue-particles> en cualquier parte.

Entrada de la App (main.ts)

import { createApp } from "vue";
import App from "./App.vue";
import type { Engine } from "@tsparticles/engine";
import { ParticlesPlugin } from "@tsparticles/vue3";
import { loadFull } from "tsparticles";

const app = createApp(App);

app.use(ParticlesPlugin, {
  init: async (engine: Engine) => {
    await loadFull(engine);
  },
});

app.mount("#app");

Componente (App.vue)

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";

const options: ISourceOptions = {
  background: {
    color: "#0d47a1",
  },
  fpsLimit: 120,
  particles: {
    number: {
      value: 80,
    },
    color: {
      value: "#ffffff",
    },
    shape: {
      type: "circle",
    },
    opacity: {
      value: 0.5,
    },
    size: {
      value: { min: 1, max: 5 },
    },
    links: {
      enable: true,
      distance: 150,
      color: "#ffffff",
      opacity: 0.4,
      width: 1,
    },
    move: {
      enable: true,
      speed: 2,
      direction: "none",
      random: false,
      straight: false,
      outModes: "out",
    },
  },
  interactivity: {
    events: {
      onHover: {
        enable: true,
        mode: "repulse",
      },
    },
    modes: {
      repulse: {
        distance: 100,
      },
    },
  },
};
</script>

<template>
  <vue-particles id="tsparticles" :options="options" />
</template>

---

---

Eventos

El componente emite varios eventos del ciclo de vida:

<script setup lang="ts">
import type { Container } from "@tsparticles/engine";

const particlesLoaded = async (container: Container): Promise<void> => {
  console.log("Contenedor de partículas cargado", container);
};
</script>

<template>
  <vue-particles id="tsparticles" :options="options" @particles-loaded="particlesLoaded" />
</template>

---

Efecto Confeti

Usa el preset de confeti para celebraciones:

npm install @tsparticles/preset-confetti

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";

const options: ISourceOptions = {
  preset: "confetti",
  background: {
    color: "transparent",
  },
};
</script>

<template>
  <vue-particles id="confetti" :options="options" />
</template>

> **Nota:** Registra el `loadConfettiPreset` en el punto de entrada de tu aplicación a través del callback `init` del
plugin (consulta [Uso Básico](#uso-básico)).

Para una explosión única, carga el preset y luego llama a tsParticles.load() programáticamente dentro de un método.

---

Efecto Fuegos Artificiales

El preset de fuegos artificiales crea explosiones de partículas de alto impacto:

npm install @tsparticles/preset-fireworks

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";

const options: ISourceOptions = {
  preset: "fireworks",
  background: {
    color: "#000000",
  },
};
</script>

<template>
  <vue-particles id="fireworks" :options="options" />
</template>

> **Nota:** Registra el `loadFireworksPreset` en el punto de entrada de tu aplicación a través del callback `init` del
plugin (consulta [Uso Básico](#uso-básico)).

Consejo: El preset de fuegos artificiales consume muchos recursos. Actívalo en una interacción del usuario (ej., clic de botón) alternando un v-if vinculado al componente.

---

Efecto Nieve

Simula nieve cayendo con el preset de nieve:

npm install @tsparticles/preset-snow

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";

const options: ISourceOptions = {
  preset: "snow",
  background: {
    color: "#1a1a2e",
  },
};
</script>

<template>
  <vue-particles id="snow" :options="options" />
</template>

> **Nota:** Registra el `loadSnowPreset` en el punto de entrada de tu aplicación a través del callback `init` del plugin
(consulta [Uso Básico](#uso-básico)).

---

Partículas Interactivas

Añade modos de interactividad de hover y clic:

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";

const options: ISourceOptions = {
  background: {
    color: "#0d0d0d",
  },
  particles: {
    number: {
      value: 100,
    },
    color: {
      value: "#00ff00",
    },
    shape: {
      type: "circle",
    },
    opacity: {
      value: 0.6,
    },
    size: {
      value: { min: 1, max: 4 },
    },
    links: {
      enable: true,
      distance: 120,
      color: "#00ff00",
      opacity: 0.3,
      width: 1,
    },
    move: {
      enable: true,
      speed: 3,
    },
  },
  interactivity: {
    events: {
      onHover: {
        enable: true,
        mode: "grab",
      },
      onClick: {
        enable: true,
        mode: "push",
      },
    },
    modes: {
      grab: {
        distance: 180,
        links: {
          opacity: 0.5,
        },
      },
      push: {
        quantity: 4,
      },
    },
  },
};
</script>

<template>
  <vue-particles id="interactive" :options="options" />
</template>

Modos de interacción disponibles: grab, repulse, bubble, connect, push, remove, trail, attract, light.

---

Cambio de Tema

Intercambia dinámicamente los temas de partículas en tiempo de ejecución actualizando el objeto de opciones reactivo:

<script setup lang="ts">
import { ref } from "vue";
import type { ISourceOptions } from "@tsparticles/engine";

const isDark = ref(true);

const options = ref<ISourceOptions>({
  background: {
    color: "#000000",
  },
  particles: {
    color: {
      value: "#ffffff",
    },
    links: {
      color: "#ffffff",
    },
    number: {
      value: 60,
    },
    move: {
      enable: true,
      speed: 2,
    },
    size: {
      value: { min: 1, max: 3 },
    },
  },
});

const toggleTheme = () => {
  isDark.value = !isDark.value;
  options.value = {
    ...options.value,
    background: {
      color: isDark.value ? "#000000" : "#f0f0f0",
    },
    particles: {
      ...options.value.particles,
      color: {
        value: isDark.value ? "#ffffff" : "#333333",
      },
      links: {
        ...(options.value.particles?.links as object),
        color: isDark.value ? "#ffffff" : "#333333",
      },
    },
  };
};
</script>

<template>
  <div>
    <button @click="toggleTheme">Cambiar a {{ isDark ? "claro" : "oscuro" }}</button>
    <vue-particles id="theme-particles" :options="options" />
  </div>
</template>

El componente <vue-particles> también soporta una prop theme para el cambio sin configuración. Cuando la prop theme cambia, el componente aplica el nuevo tema sin destruir y recrear el contenedor:

<template>
  <vue-particles id="tsparticles" :options="options" :theme="currentTheme" />
</template>

Nota: La prop theme requiere el paquete opcional @tsparticles/plugin-themes. Sin él, la prop theme es un no-op seguro — no se lanza ningún error, pero el cambio de tema se ignora.

---

Preset Personalizado desde @tsparticles/configs

El paquete @tsparticles/configs exporta objetos de configuración predefinidos:

npm install @tsparticles/configs

<script setup lang="ts">
import type { ISourceOptions } from "@tsparticles/engine";
import particlesConfig from "@tsparticles/configs/particles.json";

const options: ISourceOptions = {
  ...particlesConfig,
  background: {
    color: "#1e1e2e",
  },
};
</script>

<template>
  <vue-particles id="config-particles" :options="options" />
</template>

> **Nota:** Registra el `loadLinksPreset` en el punto de entrada de tu aplicación a través del callback `init` del
plugin (consulta [Uso Básico](#uso-básico)).

Explora las configuraciones disponibles en el paquete @tsparticles/configs para diseños listos para usar.

---

Enfoques de Inicialización del Motor

Hay dos formas de inicializar el motor:

1. Plugin Global (recomendado)

// main.ts
import { createApp } from "vue";
import App from "./App.vue";
import type { Engine } from "@tsparticles/engine";
import { ParticlesPlugin } from "@tsparticles/vue3";
import { loadFull } from "tsparticles";

createApp(App)
  .use(ParticlesPlugin, {
    init: async (engine: Engine) => {
      await loadFull(engine);
    },
  })
  .mount("#app");

El motor está entonces disponible globalmente y todas las instancias de <vue-particles> lo comparten.

2. Particles Provider (Composition API)

Use the provider to access the engine programmatically:

<script setup lang="ts">
import { useParticlesProvider } from "@tsparticles/vue3";
import { loadFull } from "tsparticles";

const { init } = useParticlesProvider();

await init(async (engine: Engine) => {
  await loadFull(engine);
});
</script>

---

Exportaciones Nombradas + TypeScript

Ejemplo TypeScript completo con todas las piezas juntas:

<script setup lang="ts">
import { ref } from "vue";
import type { Container, ISourceOptions } from "@tsparticles/engine";

const particlesContainer = ref<Container | null>(null);

const options: ISourceOptions = {
  background: {
    color: "#0d47a1",
  },
  fpsLimit: 60,
  particles: {
    number: {
      value: 50,
    },
    color: {
      value: "#ffd700",
    },
    shape: {
      type: ["circle", "triangle", "polygon"],
    },
    opacity: {
      value: 0.7,
      random: true,
    },
    size: {
      value: { min: 2, max: 8 },
      random: true,
    },
    links: {
      enable: true,
      distance: 200,
      color: "#ffd700",
      opacity: 0.3,
      width: 1,
    },
    move: {
      enable: true,
      speed: 2,
      direction: "none",
      random: true,
      straight: false,
      outModes: "bounce",
      attract: {
        enable: false,
      },
    },
  },
  interactivity: {
    events: {
      onHover: {
        enable: true,
        mode: "bubble",
      },
      onClick: {
        enable: true,
        mode: "repulse",
      },
    },
    modes: {
      bubble: {
        distance: 200,
        size: 12,
        duration: 0.3,
      },
      repulse: {
        distance: 200,
      },
    },
  },
  detectRetina: true,
};

const particlesLoaded = async (container: Container): Promise<void> => {
  particlesContainer.value = container;
  console.log("Contenedor listo", container);
};
</script>

<template>
  <vue-particles id="tsparticles" :options="options" @particles-loaded="particlesLoaded" />
</template>

---

Referencia de API

Prop	Type	Default	Description
id	string	"tsparticles"	ID del elemento canvas
options	ISourceOptions	{}	Configuración de partículas
url	string	—	URL para cargar configuración JSON
theme	string	—	Nombre del tema a aplicar (requiere @tsparticles/plugin-themes; seguro si no está presente)

Evento	Carga	Descripción
@particles-loaded	Container	Se dispara cuando el contenedor está completamente inicializado

---

Solución de Problemas

• Error: tsparticles is not defined — Asegúrate de que tsparticles (o los presets que necesites) se carguen dentro del callback init antes de que el componente se renderice.
• Canvas no visible — Verifica que el contenedor padre tenga una altura no nula. Añade una regla CSS como #tsparticles { height: 100vh; }.
• Problemas de rendimiento — Reduce fpsLimit, disminuye particles.number.value, o desactiva detectRetina en dispositivos de gama baja.
• SSR (Nuxt) — El componente <vue-particles> es solo de cliente. Envuélvelo en <ClientOnly> o usa la directiva client:only.