@tsparticles/preset-links

tsParticles Links Preset

tsParticles preset for creating a particles web created by link lines between them.

Sample

Quick checklist

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

How to use it

CDN / Vanilla JS / jQuery

<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-links@4/tsparticles.preset.links.min.js"></script>

Usage

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

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

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

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

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 loadLinksPreset 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 loadLinksPreset(tsParticles)
• Changing particle shape without loading the corresponding shape package
• Links are rendered between nearby particles; with very few particles or a large links.distance value, no lines may appear

Related docs

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

flowchart TD

subgraph b [Bundles]
bb[tsParticles Basic]
end

subgraph i [Interactions]

subgraph ip [Particles]
ipl[Links]
end

end

bb --> i

subgraph pl [Plugins]
pli[Interactivity]
end

bb --> pl

subgraph pr [Presets]
prl[Links]
end

bb & ipl & pli --> prl