npm.io
4.3.2 • Published 1 week ago

@tsparticles/updater-tilt

Licence
MIT
Version
4.3.2
Deps
1
Size
198 kB
Vulns
0
Weekly
0
Stars
8.9K

banner

tsParticles Tilt Updater

jsDelivr npmjs npmjs GitHub Sponsors

tsParticles updater plugin for tilt animations.

Quick checklist

  1. Install @tsparticles/engine (or use the CDN bundle below)
  2. Call the package loader function(s) before tsParticles.load(...)
  3. Apply the package options in your tsParticles.load(...) config

How to use it

CDN / Vanilla JS / jQuery

The CDN/Vanilla version JS has one required file in vanilla configuration:

Including the tsparticles.updater.tilt.min.js file will export the function to load the updater plugin:

loadTiltUpdater;
Usage

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

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

  await tsParticles.load({
    id: "tsparticles",
    options: {/* options */},
  });
})();
ESM / CommonJS

This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:

$ npm install @tsparticles/updater-tilt

or

$ yarn add @tsparticles/updater-tilt

Then you need to import it in the app, like this:

const { tsParticles } = require("@tsparticles/engine");
const { loadTiltUpdater } = require("@tsparticles/updater-tilt");

(async () => {
  await loadTiltUpdater(tsParticles);
})();

or

import { tsParticles } from "@tsparticles/engine";
import { loadTiltUpdater } from "@tsparticles/updater-tilt";

(async () => {
  await loadTiltUpdater(tsParticles);
})();

Option mapping

  • Primary options key: particles.tilt
{
  "particles": {
    "tilt": {}
  }
}

Common pitfalls

  • Calling tsParticles.load(...) before loadTiltUpdater(...)
  • Verify required peer packages before enabling advanced options
  • Change one option group at a time to isolate regressions quickly

Keywords