Package Exports

@tsparticles/preset-stars
@tsparticles/preset-stars/cjs/index.js
@tsparticles/preset-stars/esm/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tsparticles/preset-stars) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tsParticles Stars Preset

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

Sample

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>

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",
    },
  });
})();

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",
  },
});

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.

flowchart TD

subgraph pr [Presets]
prst[Stars]
end

bb[tsParticles Basic] --> prst