@tsparticles/preset-squares 3.0.1 → 3.1.0

package/README.md

@@ -4,7 +4,7 @@
 
 [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/preset-squares/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/preset-squares) [![npmjs](https://badge.fury.io/js/@tsparticles/preset-squares.svg)](https://www.npmjs.com/package/@tsparticles/preset-squares) [![npmjs](https://img.shields.io/npm/dt/@tsparticles/preset-squares)](https://www.npmjs.com/package/@tsparticles/preset-squares) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
 
-[tsParticles](https://github.com/matteobruni/tsparticles) preset creating a squares effect with falling particles.
+[tsParticles](https://github.com/tsparticles/tsparticles) preset creating a squares effect with falling particles.
 
 [![Slack](https://particles.js.org/images/slack.png)](https://join.slack.com/t/tsparticles/shared_invite/enQtOTcxNTQxNjQ4NzkxLWE2MTZhZWExMWRmOWI5MTMxNjczOGE1Yjk0MjViYjdkYTUzODM3OTc5MGQ5MjFlODc4MzE0N2Q1OWQxZDc1YzI) [![Discord](https://particles.js.org/images/discord.png)](https://discord.gg/hACwv45Hme) [![Telegram](https://particles.js.org/images/telegram.png)](https://t.me/tsparticles)
 
@@ -12,36 +12,14 @@
 
 ## Sample
 
-[![demo](https://raw.githubusercontent.com/matteobruni/tsparticles/main/presets/squares/images/sample.png)](https://particles.js.org/samples/presets/squares)
+[![demo](https://raw.githubusercontent.com/tsparticles/tsparticles/main/presets/squares/images/sample.png)](https://particles.js.org/samples/presets/squares)
 
 ## How to use it
 
 ### CDN / Vanilla JS / jQuery
 
-The first step is installing [tsParticles](https://github.com/matteobruni/tsparticles) following the instructions for
-vanilla javascript in the main project [here](https://github.com/matteobruni/tsparticles)
-
-Once installed you need one more script to be included in your page (or you can download that
-from [jsDelivr](https://www.jsdelivr.com/package/npm/@tsparticles/preset-squares):
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/engine@2/tsparticles.engine.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/plugin-emitters@2/tsparticles.plugin.emitters.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/shape-square@2/tsparticles.shape.square.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/updater-rotate@2/tsparticles.updater.rotate.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/updater-size@2/tsparticles.updater.size.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/updater-stroke-color@2/tsparticles.updater.stroke-color.min.js"></script>
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-squares@2/tsparticles.preset.squares.min.js"></script>
-```
-
-This script **MUST** be placed after the `tsParticles` one.
-
-#### Bundle
-
-A bundled script can also be used, this will include every needed plugin needed by the preset.
-
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-squares@2/tsparticles.preset.squares.bundle.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@tsparticles/preset-squares@3/tsparticles.preset.squares.bundle.min.js"></script>
 ```
 
 ### Usage
@@ -50,10 +28,13 @@ Once the scripts are loaded you can set up `tsParticles` like this:
 
 ```javascript
 (async () => {
-  await loadSquaresPreset(tsParticles); // this is required only if you are not using the bundle script
+  await loadSquaresPreset(tsParticles);
 
-  await tsParticles.load("tsparticles", {
-    preset: "squares",
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      preset: "squares",
+    },
   });
 })();
 ```
@@ -64,100 +45,27 @@ Once the scripts are loaded you can set up `tsParticles` like this:
 You can override all the options defining the properties like in any standard `tsParticles` installation.
 
 ```javascript
-tsParticles.load("tsparticles", {
-  particles: {
-    shape: {
-      type: "circle", // starting from v2, this require the circle shape script
+tsParticles.load({
+  id: "tsparticles",
+  options: {
+    particles: {
+      shape: {
+        type: "circle", // starting from v2, this require the circle shape script
+      },
     },
+    preset: "squares",
   },
-  preset: "squares",
 });
 ```
 
 Like in the sample above, the circles will be replaced by squares.
 
-### React.js / Preact / Inferno
-
-_The syntax for `React.js`, `Preact` and `Inferno` is the same_.
-
-This sample uses the class component syntax, but you can use hooks as well (if the library supports it).
-
-```typescript jsx
-import Particles from "react-particles";
-import type { Engine } from "@tsparticles/engine";
-import { loadSquaresPreset } from "@tsparticles/preset-squares";
-
-export class ParticlesContainer extends React.PureComponent<IProps> {
-  // this customizes the component tsParticles installation
-  async customInit(engine: Engine): Promise<void> {
-    // this adds the preset to tsParticles, you can safely use the
-    await loadSquaresPreset(engine);
-  }
-
-  render() {
-    const options = {
-      preset: "squares",
-    };
-
-    return <Particles options={options} init={this.customInit} />;
-  }
-}
-```
+### Frameworks with a tsParticles component library
 
-### Vue (2.x and 3.x)
+Checkout the documentation in the component library repository and call the `loadSquaresPreset` function instead
+of `loadFull`, `loadSlim` or similar functions.
 
-_The syntax for `Vue.js 2.x` and `3.x` is the same_
-
-```vue
-<Particles id="tsparticles" :particlesInit="particlesInit" :options="particlesOptions" />
-```
-
-```ts
-const particlesOptions = {
-  preset: "squares",
-};
-
-async function particlesInit(engine: Engine): Promise<void> {
-  await loadSquaresPreset(engine);
-}
-```
-
-### Angular
-
-```html
-<ng-particles [id]="id" [options]="particlesOptions" [particlesInit]="particlesInit"></ng-particles>
-```
-
-```ts
-const particlesOptions = {
-  preset: "squares",
-};
-
-async function particlesInit(engine: Engine): Promise<void> {
-  await loadSquaresPreset(engine);
-}
-```
-
-### Svelte
-
-```sveltehtml
-
-<Particles
-        id="tsparticles"
-        options={particlesOptions}
-        particlesInit={particlesInit}
-/>
-```
-
-```js
-let particlesOptions = {
-  preset: "bubbles",
-};
-
-let particlesInit = async (engine) => {
-  await loadSquaresPreset(engine);
-};
-```
+The options shown above are valid for all the component libraries.
 
 ---
 

package/browser/bundle.js

@@ -1,4 +1,3 @@
 import { loadSquaresPreset } from "./index.js";
 import { tsParticles } from "@tsparticles/engine";
-void loadSquaresPreset(tsParticles);
 export { loadSquaresPreset, tsParticles };

package/browser/index.js

@@ -10,5 +10,6 @@ export async function loadSquaresPreset(engine, refresh = true) {
     await loadRotateUpdater(engine, false);
     await loadSizeUpdater(engine, false);
     await loadStrokeColorUpdater(engine, false);
-    await engine.addPreset("squares", options, refresh);
+    await engine.addPreset("squares", options, false);
+    await engine.refresh(refresh);
 }

package/browser/options.js

@@ -1,3 +1,4 @@
+import { DestroyType, RotateDirection, StartValueType } from "@tsparticles/engine";
 export const options = {
     particles: {
         stroke: {
@@ -26,7 +27,7 @@ export const options = {
         },
         rotate: {
             value: 0,
-            direction: "counter-clockwise",
+            direction: RotateDirection.counterClockwise,
             animation: {
                 enable: true,
                 speed: 2,
@@ -37,10 +38,10 @@ export const options = {
             value: { min: 1, max: 500 },
             animation: {
                 enable: true,
-                startValue: "min",
+                startValue: StartValueType.min,
                 speed: 60,
                 sync: true,
-                destroy: "max",
+                destroy: DestroyType.max,
             },
         },
     },

package/cjs/bundle.js

@@ -5,4 +5,3 @@ const index_js_1 = require("./index.js");
 Object.defineProperty(exports, "loadSquaresPreset", { enumerable: true, get: function () { return index_js_1.loadSquaresPreset; } });
 const engine_1 = require("@tsparticles/engine");
 Object.defineProperty(exports, "tsParticles", { enumerable: true, get: function () { return engine_1.tsParticles; } });
-void (0, index_js_1.loadSquaresPreset)(engine_1.tsParticles);

package/cjs/index.js

@@ -13,6 +13,7 @@ async function loadSquaresPreset(engine, refresh = true) {
     await (0, updater_rotate_1.loadRotateUpdater)(engine, false);
     await (0, updater_size_1.loadSizeUpdater)(engine, false);
     await (0, updater_stroke_color_1.loadStrokeColorUpdater)(engine, false);
-    await engine.addPreset("squares", options_js_1.options, refresh);
+    await engine.addPreset("squares", options_js_1.options, false);
+    await engine.refresh(refresh);
 }
 exports.loadSquaresPreset = loadSquaresPreset;

package/cjs/options.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.options = void 0;
+const engine_1 = require("@tsparticles/engine");
 exports.options = {
     particles: {
         stroke: {
@@ -29,7 +30,7 @@ exports.options = {
         },
         rotate: {
             value: 0,
-            direction: "counter-clockwise",
+            direction: engine_1.RotateDirection.counterClockwise,
             animation: {
                 enable: true,
                 speed: 2,
@@ -40,10 +41,10 @@ exports.options = {
             value: { min: 1, max: 500 },
             animation: {
                 enable: true,
-                startValue: "min",
+                startValue: engine_1.StartValueType.min,
                 speed: 60,
                 sync: true,
-                destroy: "max",
+                destroy: engine_1.DestroyType.max,
             },
         },
     },

package/esm/bundle.js

@@ -1,4 +1,3 @@
 import { loadSquaresPreset } from "./index.js";
 import { tsParticles } from "@tsparticles/engine";
-void loadSquaresPreset(tsParticles);
 export { loadSquaresPreset, tsParticles };

package/esm/index.js

@@ -10,5 +10,6 @@ export async function loadSquaresPreset(engine, refresh = true) {
     await loadRotateUpdater(engine, false);
     await loadSizeUpdater(engine, false);
     await loadStrokeColorUpdater(engine, false);
-    await engine.addPreset("squares", options, refresh);
+    await engine.addPreset("squares", options, false);
+    await engine.refresh(refresh);
 }

package/esm/options.js

@@ -1,3 +1,4 @@
+import { DestroyType, RotateDirection, StartValueType } from "@tsparticles/engine";
 export const options = {
     particles: {
         stroke: {
@@ -26,7 +27,7 @@ export const options = {
         },
         rotate: {
             value: 0,
-            direction: "counter-clockwise",
+            direction: RotateDirection.counterClockwise,
             animation: {
                 enable: true,
                 speed: 2,
@@ -37,10 +38,10 @@ export const options = {
             value: { min: 1, max: 500 },
             animation: {
                 enable: true,
-                startValue: "min",
+                startValue: StartValueType.min,
                 speed: 60,
                 sync: true,
-                destroy: "max",
+                destroy: DestroyType.max,
             },
         },
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsparticles/preset-squares",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "tsParticles squares preset",
   "homepage": "https://particles.js.org",
   "repository": {
@@ -87,12 +87,12 @@
   "module": "esm/index.js",
   "types": "types/index.d.ts",
   "dependencies": {
-    "@tsparticles/engine": "^3.0.0",
-    "@tsparticles/plugin-emitters": "^3.0.0",
-    "@tsparticles/shape-square": "^3.0.0",
-    "@tsparticles/updater-rotate": "^3.0.0",
-    "@tsparticles/updater-size": "^3.0.0",
-    "@tsparticles/updater-stroke-color": "^3.0.0"
+    "@tsparticles/engine": "^3.4.0",
+    "@tsparticles/plugin-emitters": "^3.4.0",
+    "@tsparticles/shape-square": "^3.4.0",
+    "@tsparticles/updater-rotate": "^3.4.0",
+    "@tsparticles/updater-size": "^3.4.0",
+    "@tsparticles/updater-stroke-color": "^3.4.0"
   },
   "publishConfig": {
     "access": "public"