README

tsParticles - TypeScript Particles

A lightweight TypeScript library for creating particles. Dependency free (\), browser ready and compatible with
React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Riot.js, Solid.js, and Web Components



















---

 Table of Contents

- tsParticles - TypeScript Particles
  - Table of Contents
  - Do you want to use it on your website?
  - Start here in 2 minutes
  - _Library installation_
    - _Hosting / CDN_
      - jsDelivr
      - cdnjs
      - unpkg
    - _npm_
    - _yarn_
    - _pnpm_
      - Import and require
    - _Usage_
  - Official components for some of the most used frameworks
    - Angular
      - @tsparticles/angular
    - Astro
      - @tsparticles/astro
    - Ember.js
      - @tsparticles/ember
    - Inferno
      - @tsparticles/inferno
    - jQuery
      - @tsparticles/jquery
    - Preact
      - @tsparticles/preact
    - Qwik
      - @tsparticles/qwik
    - ReactJS
      - @tsparticles/nextjs
      - @tsparticles/react
    - RiotJS
      - @tsparticles/riot
    - SolidJS
      - @tsparticles/solid
    - Svelte
      - @tsparticles/svelte
    - VueJS 2.x
      - @tsparticles/nuxt2
      - @tsparticles/vue2
    - VueJS 3.x
      - @tsparticles/nuxt3
      - @tsparticles/nuxt4
      - @tsparticles/vue3
    - Web Components
      - @tsparticles/webcomponents
    - WordPress
      - @tsparticles/wordpress
    - Elementor
  - Presets
    - Ambient
    - Big Circles
    - Bubbles
    - Confetti
    - Confetti Cannon
    - Confetti Explosions
    - Confetti Falling
    - Confetti Parade
    - Party
    - Fire
    - Firefly
    - Fireworks
    - Fountain
    - Hyperspace
    - Links
    - Sea Anemone
    - Snow
    - Squares
    - Stars
    - Triangles
  - Templates and Resources
  - _Demo / Generator_
  - _Video Tutorials_
    - Characters as particles
    - Polygon mask
    - Animated stars
    - Nyan cat flying on scrolling stars
    - Snow particles
    - Background Mask particles
  - _Options_
  - Want to see it in action and try it?
  - Migrating from Particles.js
  - Plugins/Customizations
  - Dependency Graph

---

 Do you want to use it on your website?

_Documentation and Development references here 📖_

This library is available on two of the most popular CDNs and it's easy and ready to use, if you were using
particles.js
it's even easier.

You'll find the
instructions below, with all the
links you need, and _don't be scared by TypeScript, it's just the source language_.

The output files are just JavaScript. 🤩

CDNs and npm have all the sources you need in Javascript, a bundle browser ready (tsparticles.engine.min.js), and
all
files splitted for import syntax.

If you are interested there are some _simple instructions_
just below to guide you to
migrate from the old particles.js library.

 Start here in 2 minutes

If you are new to tsParticles, this path is usually the fastest:

1. Install @tsparticles/engine and @tsparticles/slim
2. Load the slim bundle o