tsParticles Stars Preset

tsParticles preset for creating a starry night effect with blinking stars.

Sample

Quick checklist

1. Install @tsparticles/engine (or use the CDN bundle below)
2. Call loadStarsPreset(tsParticles) before tsParticles.load(...)
3. Set preset: "stars" in options

How to use it

CDN / Vanilla JS / jQuery

<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-stars@3/tsparticles.preset.stars.bundle.min.js"></script>
Copy

Usage

Once the scripts are loaded you can set up tsParticles like this:

(async () => {
  await loadStarsPreset(tsParticles);

  await tsParticles.load({
    id: "tsparticles",
    options: {
      preset: "stars",
    },
  });
})();
Copy

Customization

Important ⚠️ You can override all the options defining the properties like in any standard tsParticles installation.

tsParticles.load({
  id: "tsparticles",
  options: {
    particles: {
      shape: {
        type: "square", // starting from v2, this require the square shape script
      },
    },
    preset: "stars",
  },
});
Copy

Like in the sample above, the circles will be replaced by squares.

Frameworks with a tsParticles component library

Checkout the documentation in the component library repository and call the loadStarsPreset function instead of loadFull, loadSlim or similar functions.

The options shown above are valid for all the component libraries.

Dependencies

This preset loads and combines the following packages:

If you want to customize one specific behavior, start from the related package README above.

Common pitfalls

• Calling tsParticles.load(...) before loadStarsPreset(tsParticles)
• Changing particle shape without loading the corresponding shape package
• The stars preset uses a dark background by default; override background.color if you need a different style

Related docs

• All presets catalog: https://github.com/tsparticles/presets
• Color formats: https://github.com/tsparticles/tsparticles/blob/main/markdown/Color.md
• Main tsParticles docs: https://particles.js.org/docs/

flowchart TD

subgraph b [Bundles]
bb[tsParticles Basic]
end

subgraph pr [Presets]
prst[Stars]
end

bb --> prst
Copy