@tsparticles/preset-squares 3.0.0-beta.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Matteo Bruni
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,194 @@
+[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
+
+# tsParticles Squares Preset
+
+[![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.
+
+[![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)
+
+[![tsParticles Product Hunt](https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=186113&theme=light)](https://www.producthunt.com/posts/tsparticles?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-tsparticles") <a href="https://www.buymeacoffee.com/matteobruni"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a beer&emoji=🍺&slug=matteobruni&button_colour=5F7FFF&font_colour=ffffff&font_family=Arial&outline_colour=000000&coffee_colour=FFDD00"></a>
+
+## Sample
+
+[![demo](https://raw.githubusercontent.com/matteobruni/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>
+```
+
+### Usage
+
+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 tsParticles.load("tsparticles", {
+    preset: "squares",
+  });
+})();
+```
+
+#### Customization
+
+**Important ⚠️**
+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
+    },
+  },
+  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} />;
+  }
+}
+```
+
+### Vue (2.x and 3.x)
+
+_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);
+};
+```
+
+---
+
+```mermaid
+flowchart TD
+
+e[tsParticles Engine]
+
+subgraph pl [Plugins]
+ple[Emitters]
+end
+
+e --> pl
+
+subgraph s [Shapes]
+ssq[Square]
+end
+
+e --> s
+
+subgraph u [Updaters]
+urot[Rotate]
+usi[Size]
+usc[Stroke Color]
+end
+
+e --> u
+
+subgraph pr [Presets]
+prsn[Squares]
+end
+
+e & ple & ssq & urot & usi & usc --> prsn
+```

package/browser/bundle.js

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

package/browser/index.js

@@ -0,0 +1,14 @@
+import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
+import { loadRotateUpdater } from "@tsparticles/updater-rotate";
+import { loadSizeUpdater } from "@tsparticles/updater-size";
+import { loadSquareShape } from "@tsparticles/shape-square";
+import { loadStrokeColorUpdater } from "@tsparticles/updater-stroke-color";
+import { options } from "./options";
+export async function loadSquaresPreset(engine, refresh = true) {
+    await loadEmittersPlugin(engine, false);
+    await loadSquareShape(engine, false);
+    await loadRotateUpdater(engine, false);
+    await loadSizeUpdater(engine, false);
+    await loadStrokeColorUpdater(engine, false);
+    await engine.addPreset("squares", options, refresh);
+}

package/browser/options.js

@@ -0,0 +1,60 @@
+export const options = {
+    particles: {
+        stroke: {
+            width: 5,
+            color: {
+                value: [
+                    "#5bc0eb",
+                    "#fde74c",
+                    "#9bc53d",
+                    "#e55934",
+                    "#fa7921",
+                    "#2FF3E0",
+                    "#F8D210",
+                    "#FA26A0",
+                    "#F51720",
+                ],
+            },
+        },
+        shape: {
+            type: "square",
+            options: {
+                square: {
+                    fill: false,
+                },
+            },
+        },
+        rotate: {
+            value: 0,
+            direction: "counter-clockwise",
+            animation: {
+                enable: true,
+                speed: 2,
+                sync: true,
+            },
+        },
+        size: {
+            value: { min: 1, max: 500 },
+            animation: {
+                enable: true,
+                startValue: "min",
+                speed: 60,
+                sync: true,
+                destroy: "max",
+            },
+        },
+    },
+    background: {
+        color: "#000",
+    },
+    emitters: {
+        position: {
+            y: 50,
+            x: 50,
+        },
+        rate: {
+            delay: 1,
+            quantity: 1,
+        },
+    },
+};

package/cjs/bundle.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.tsParticles = exports.loadSquaresPreset = void 0;
+const _1 = require(".");
+Object.defineProperty(exports, "loadSquaresPreset", { enumerable: true, get: function () { return _1.loadSquaresPreset; } });
+const engine_1 = require("@tsparticles/engine");
+Object.defineProperty(exports, "tsParticles", { enumerable: true, get: function () { return engine_1.tsParticles; } });
+(0, _1.loadSquaresPreset)(engine_1.tsParticles);

package/cjs/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadSquaresPreset = void 0;
+const plugin_emitters_1 = require("@tsparticles/plugin-emitters");
+const updater_rotate_1 = require("@tsparticles/updater-rotate");
+const updater_size_1 = require("@tsparticles/updater-size");
+const shape_square_1 = require("@tsparticles/shape-square");
+const updater_stroke_color_1 = require("@tsparticles/updater-stroke-color");
+const options_1 = require("./options");
+async function loadSquaresPreset(engine, refresh = true) {
+    await (0, plugin_emitters_1.loadEmittersPlugin)(engine, false);
+    await (0, shape_square_1.loadSquareShape)(engine, false);
+    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_1.options, refresh);
+}
+exports.loadSquaresPreset = loadSquaresPreset;

package/cjs/options.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.options = void 0;
+exports.options = {
+    particles: {
+        stroke: {
+            width: 5,
+            color: {
+                value: [
+                    "#5bc0eb",
+                    "#fde74c",
+                    "#9bc53d",
+                    "#e55934",
+                    "#fa7921",
+                    "#2FF3E0",
+                    "#F8D210",
+                    "#FA26A0",
+                    "#F51720",
+                ],
+            },
+        },
+        shape: {
+            type: "square",
+            options: {
+                square: {
+                    fill: false,
+                },
+            },
+        },
+        rotate: {
+            value: 0,
+            direction: "counter-clockwise",
+            animation: {
+                enable: true,
+                speed: 2,
+                sync: true,
+            },
+        },
+        size: {
+            value: { min: 1, max: 500 },
+            animation: {
+                enable: true,
+                startValue: "min",
+                speed: 60,
+                sync: true,
+                destroy: "max",
+            },
+        },
+    },
+    background: {
+        color: "#000",
+    },
+    emitters: {
+        position: {
+            y: 50,
+            x: 50,
+        },
+        rate: {
+            delay: 1,
+            quantity: 1,
+        },
+    },
+};

package/esm/bundle.js

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

package/esm/index.js

@@ -0,0 +1,14 @@
+import { loadEmittersPlugin } from "@tsparticles/plugin-emitters";
+import { loadRotateUpdater } from "@tsparticles/updater-rotate";
+import { loadSizeUpdater } from "@tsparticles/updater-size";
+import { loadSquareShape } from "@tsparticles/shape-square";
+import { loadStrokeColorUpdater } from "@tsparticles/updater-stroke-color";
+import { options } from "./options";
+export async function loadSquaresPreset(engine, refresh = true) {
+    await loadEmittersPlugin(engine, false);
+    await loadSquareShape(engine, false);
+    await loadRotateUpdater(engine, false);
+    await loadSizeUpdater(engine, false);
+    await loadStrokeColorUpdater(engine, false);
+    await engine.addPreset("squares", options, refresh);
+}

package/esm/options.js

@@ -0,0 +1,60 @@
+export const options = {
+    particles: {
+        stroke: {
+            width: 5,
+            color: {
+                value: [
+                    "#5bc0eb",
+                    "#fde74c",
+                    "#9bc53d",
+                    "#e55934",
+                    "#fa7921",
+                    "#2FF3E0",
+                    "#F8D210",
+                    "#FA26A0",
+                    "#F51720",
+                ],
+            },
+        },
+        shape: {
+            type: "square",
+            options: {
+                square: {
+                    fill: false,
+                },
+            },
+        },
+        rotate: {
+            value: 0,
+            direction: "counter-clockwise",
+            animation: {
+                enable: true,
+                speed: 2,
+                sync: true,
+            },
+        },
+        size: {
+            value: { min: 1, max: 500 },
+            animation: {
+                enable: true,
+                startValue: "min",
+                speed: 60,
+                sync: true,
+                destroy: "max",
+            },
+        },
+    },
+    background: {
+        color: "#000",
+    },
+    emitters: {
+        position: {
+            y: 50,
+            x: 50,
+        },
+        rate: {
+            delay: 1,
+            quantity: 1,
+        },
+    },
+};

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@tsparticles/preset-squares",
+  "version": "3.0.0-beta.4",
+  "description": "tsParticles squares preset",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tsparticles/presets.git",
+    "directory": "presets/squares"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles.js",
+    "particlesjs",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles-bg",
+    "particles-bg-vue",
+    "particles-ts",
+    "particles.ts",
+    "react-particles-js",
+    "react-particles.js",
+    "react-particles",
+    "react",
+    "reactjs",
+    "vue-particles",
+    "ngx-particles",
+    "angular-particles",
+    "particleground",
+    "vue",
+    "vuejs",
+    "preact",
+    "preactjs",
+    "jquery",
+    "angularjs",
+    "angular",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "confetti",
+    "canvas",
+    "fireworks",
+    "fireworks-js",
+    "confetti-js",
+    "confettijs",
+    "fireworksjs",
+    "canvas-confetti",
+    "tsparticles-preset"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tsparticles/presets/issues"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/matteobruni"
+    },
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/tsparticles"
+    },
+    {
+      "type": "buymeacoffee",
+      "url": "https://www.buymeacoffee.com/matteobruni"
+    }
+  ],
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.preset.squares.min.js",
+  "unpkg": "tsparticles.preset.squares.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.4",
+    "@tsparticles/plugin-emitters": "^3.0.0-beta.4",
+    "@tsparticles/shape-square": "^3.0.0-beta.4",
+    "@tsparticles/updater-rotate": "^3.0.0-beta.4",
+    "@tsparticles/updater-size": "^3.0.0-beta.4",
+    "@tsparticles/updater-stroke-color": "^3.0.0-beta.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}