Интеграция с Vue 3

Пакет @tsparticles/vue3 предоставляет нативный компонент Vue 3 и систему плагинов для tsParticles. Это руководство охватывает всё, от базовой настройки до продвинутых паттернов, таких как динамическое переключение тем и пользовательские пресеты.

---

Установка

npm install @tsparticles/vue3 @tsparticles/engine

Опционально установите пресет или полную сборку:

# Полная сборка (все функции)
npm install tsparticles

# Конкретные пресеты
npm install @tsparticles/preset-confetti
npm install @tsparticles/preset-fireworks
npm install @tsparticles/preset-snow
npm install @tsparticles/preset-stars

# Утилитарные конфиги
npm install @tsparticles/configs

---

Базовое использование

Зарегистрируйте плагин в точке входа вашего приложения, затем используйте компонент <vue-particles> в любом месте.

Точка входа (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");

Компонент (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>

---

События

Компонент генерирует несколько событий жизненного цикла:

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

const particlesLoaded = async (container: Container): Promise<void> => {
  console.log("Контейнер частиц загружен", container);
};
</script>

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

---

Эффект конфетти

Используйте пресет конфетти для праздников:

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>

> **Примечание:** Зарегистрируйте `loadConfettiPreset` в точке входа вашего приложения через колбэк `init` плагина (см.
[Базовое использование](#базовое-использование)). Для одноразового взрыва загрузите пресет, затем вызовите
`tsParticles.load()` программно внутри метода. --- ## Эффект фейерверка Пресет фейерверка создаёт зрелищные взрывы
частиц: ```bash 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>

> **Примечание:** Зарегистрируйте `loadFireworksPreset` в точке входа вашего приложения через колбэк `init` плагина (см.
[Базовое использование](#базовое-использование)). > **Совет:** Пресет фейерверка требует много ресурсов. Запускайте его
по взаимодействию пользователя (например, по клику на кнопку), переключая `v-if`, привязанный к компоненту. --- ##
Эффект снега Симулируйте падение снега с помощью пресета snow: ```bash 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>

> **Примечание:** Зарегистрируйте `loadSnowPreset` в точке входа вашего приложения через колбэк `init` плагина (см.
[Базовое использование](#базовое-использование)). --- ## Интерактивные частицы Добавьте режимы взаимодействия при
наведении и клике: ```vue
<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>

Доступные режимы взаимодействия: grab, repulse, bubble, connect, push, remove, trail, attract, light.

---

Переключение темы

Динамически меняйте темы частиц во время выполнения, обновляя реактивный объект опций:

<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">Переключить на {{ isDark ? "светлую" : "тёмную" }}</button>
    <vue-particles id="theme-particles" :options="options" />
  </div>
</template>

Компонент <vue-particles> также поддерживает проп theme для переключения без конфигурации. Когда проп theme меняется, компонент применяет новую тему без уничтожения и воссоздания контейнера:

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

Примечание: Проп theme требует опциональный пакет @tsparticles/plugin-themes. Без него проп theme является безопасным no-op — ошибка не выбрасывается, но изменение темы игнорируется.

---

Пользовательский пресет из @tsparticles/configs

Пакет @tsparticles/configs экспортирует готовые объекты конфигурации:

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>

> **Примечание:** Зарегистрируйте `loadLinksPreset` в точке входа вашего приложения через колбэк `init` плагина (см.
[Базовое использование](#базовое-использование)). Просмотрите доступные конфиги в пакете `@tsparticles/configs` для
готовых к использованию макетов. --- ## Подходы к инициализации движка Есть два способа инициализировать движок: ### 1.
Глобальный плагин (рекомендуется) ```typescript // 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");

Затем движок доступен глобально, и все экземпляры <vue-particles> используют его.

2. Particles Provider (Composition API)

Используйте провайдер для программного доступа к движку:

<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>

---

Именованные экспорты + TypeScript

Полный пример TypeScript со всеми частями вместе:

<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("Контейнер готов", container);
};
</script>

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

---

Справочник API

Проп	Тип	По умолчанию	Описание
id	string	"tsparticles"	ID элемента canvas
options	ISourceOptions	{}	Конфигурация частиц
url	string	—	URL для загрузки JSON конфиг.
theme	string	—	Имя темы для применения (требуется @tsparticles/plugin-themes; безопасный no-op если нет)

Событие	Полезные данные	Описание
@particles-loaded	Container	Срабатывает при полной инициализации контейнера

---

Устранение неполадок

• Ошибка: tsparticles is not defined — Убедитесь, что tsparticles (или необходимые пресеты) загружены внутри колбэка init до рендеринга компонента.
• Canvas не отображается — Проверьте, что родительский контейнер имеет ненулевую высоту. Добавьте CSS-правило, например, #tsparticles { height: 100vh; }.
• Проблемы производительности — Снизьте fpsLimit, уменьшите particles.number.value или отключите detectRetina на маломощных устройствах.
• SSR (Nuxt) — Компонент <vue-particles> только для клиента. Оберните его в <ClientOnly> или используйте директиву client:only.