@tsparticles/basic 3.0.0-beta.0

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,167 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Basic Bundle
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/basic/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/basic) [![npmjs](https://badge.fury.io/js/@tsparticles/basic.svg)](https://www.npmjs.com/package/@tsparticles/basic) [![npmjs](https://img.shields.io/npm/dt/@tsparticles/basic)](https://www.npmjs.com/package/@tsparticles/basic) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) basic bundle loads the minimum features to a `@tsparticles/engine` instance for having dots moving in the canvas.
+
+**Included Packages**
+
+- [@tsparticles/engine](https://github.com/matteobruni/tsparticles/tree/main/engine)
+- [@tsparticles/move-base](https://github.com/matteobruni/tsparticles/tree/main/move/base)
+- [@tsparticles/shape-circle](https://github.com/matteobruni/tsparticles/tree/main/shapes/circle)
+- [@tsparticles/updater-color](https://github.com/matteobruni/tsparticles/tree/main/updaters/color)
+- [@tsparticles/updater-opacity](https://github.com/matteobruni/tsparticles/tree/main/updaters/opacity)
+- [@tsparticles/updater-out-modes](https://github.com/matteobruni/tsparticles/tree/main/updaters/outModes)
+- [@tsparticles/updater-size](https://github.com/matteobruni/tsparticles/tree/main/updaters/size)
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has two different files:
+
+- One is a bundle file with all the scripts included in a single file
+- One is a file including just the `loadBasic` function to load the tsParticles basic preset, all dependencies must be
+  included manually
+
+#### Bundle
+
+Including the `tsparticles.basic.bundle.min.js` file will work exactly like `v1`, you can start using the `tsParticles`
+instance in the same way.
+
+This is the easiest usage, since it's a single file with the some of the `v1` features.
+
+All new features will be added as external packages, this bundle is recommended for migrating from `v1` easily.
+
+#### Not Bundle
+
+This installation requires more work since all dependencies must be included in the page. Some lines above are all
+specified in the **Included Packages** section.
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` like this:
+
+```javascript
+(async () => {
+  await loadBasic(tsParticles); // not needed if using the bundle script, required for any other installation
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+    },
+  });
+})();
+```
+
+### 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).
+
+_Class Components_
+
+```typescript jsx
+import React from "react";
+import Particles from "react-particles";
+import type { Engine } from "@tsparticles/engine";
+import { loadBasic } from "@tsparticles/basic";
+
+export class ParticlesContainer extends PureComponent<unknown> {
+  // this customizes the component tsParticles installation
+  async customInit(engine: Engine) {
+    // this adds the bundle to tsParticles
+    await loadBasic(engine);
+  }
+
+  render() {
+    const options = {
+      /* custom options */
+    };
+
+    return <Particles options={options} init={this.customInit} />;
+  }
+}
+```
+
+_Hooks / Functional Components_
+
+```typescript jsx
+import React, { useCallback } from "react";
+import Particles from "react-particles";
+import type { Engine } from "@tsparticles/engine";
+import { loadBasic } from "@tsparticles/basic";
+
+export function ParticlesContainer(props: unknown) {
+  // this customizes the component tsParticles installation
+  const customInit = useCallback(async (engine: Engine) => {
+    // this adds the bundle to tsParticles
+    await loadBasic(engine);
+  });
+
+  const options = {
+    /* custom options */
+  };
+
+  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="options" />
+```
+
+```js
+const options = {
+    /* custom options */
+};
+
+async function particlesInit(engine: Engine) {
+    await loadBasic(engine);
+}
+```
+
+### Angular
+
+```html
+<ng-particles [id]="id" [options]="options" [particlesInit]="particlesInit"></ng-particles>
+```
+
+```ts
+const options = {
+  /* custom options */
+};
+
+async function particlesInit(engine: Engine): void {
+  await loadBasic(engine);
+}
+```
+
+### Svelte
+
+```sveltehtml
+
+<Particles
+    id="tsparticles"
+    options={options}
+    particlesInit="{particlesInit}"
+/>
+```
+
+```js
+let options = {
+  /* custom options */
+};
+
+let particlesInit = async (engine) => {
+  await loadBasic(engine);
+};
+```

package/browser/bundle.js

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

package/browser/index.js

@@ -0,0 +1,15 @@
+import { loadBaseMover } from "@tsparticles/move-base";
+import { loadCircleShape } from "@tsparticles/shape-circle";
+import { loadColorUpdater } from "@tsparticles/updater-color";
+import { loadOpacityUpdater } from "@tsparticles/updater-opacity";
+import { loadOutModesUpdater } from "@tsparticles/updater-out-modes";
+import { loadSizeUpdater } from "@tsparticles/updater-size";
+export async function loadBasic(engine, refresh = true) {
+    await loadBaseMover(engine, false);
+    await loadCircleShape(engine, false);
+    await loadColorUpdater(engine, false);
+    await loadOpacityUpdater(engine, false);
+    await loadOutModesUpdater(engine, false);
+    await loadSizeUpdater(engine, false);
+    await engine.refresh(refresh);
+}

package/cjs/bundle.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadBasic = void 0;
+const _1 = require(".");
+Object.defineProperty(exports, "loadBasic", { enumerable: true, get: function () { return _1.loadBasic; } });
+const engine_1 = require("@tsparticles/engine");
+(0, _1.loadBasic)(engine_1.tsParticles);
+__exportStar(require("@tsparticles/engine"), exports);

package/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadBasic = void 0;
+const move_base_1 = require("@tsparticles/move-base");
+const shape_circle_1 = require("@tsparticles/shape-circle");
+const updater_color_1 = require("@tsparticles/updater-color");
+const updater_opacity_1 = require("@tsparticles/updater-opacity");
+const updater_out_modes_1 = require("@tsparticles/updater-out-modes");
+const updater_size_1 = require("@tsparticles/updater-size");
+async function loadBasic(engine, refresh = true) {
+    await (0, move_base_1.loadBaseMover)(engine, false);
+    await (0, shape_circle_1.loadCircleShape)(engine, false);
+    await (0, updater_color_1.loadColorUpdater)(engine, false);
+    await (0, updater_opacity_1.loadOpacityUpdater)(engine, false);
+    await (0, updater_out_modes_1.loadOutModesUpdater)(engine, false);
+    await (0, updater_size_1.loadSizeUpdater)(engine, false);
+    await engine.refresh(refresh);
+}
+exports.loadBasic = loadBasic;

package/esm/bundle.js

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

package/esm/index.js

@@ -0,0 +1,15 @@
+import { loadBaseMover } from "@tsparticles/move-base";
+import { loadCircleShape } from "@tsparticles/shape-circle";
+import { loadColorUpdater } from "@tsparticles/updater-color";
+import { loadOpacityUpdater } from "@tsparticles/updater-opacity";
+import { loadOutModesUpdater } from "@tsparticles/updater-out-modes";
+import { loadSizeUpdater } from "@tsparticles/updater-size";
+export async function loadBasic(engine, refresh = true) {
+    await loadBaseMover(engine, false);
+    await loadCircleShape(engine, false);
+    await loadColorUpdater(engine, false);
+    await loadOpacityUpdater(engine, false);
+    await loadOutModesUpdater(engine, false);
+    await loadSizeUpdater(engine, false);
+    await engine.refresh(refresh);
+}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@tsparticles/basic",
+  "version": "3.0.0-beta.0",
+  "description": "Easily create highly customizable particle animations and use them as animated backgrounds for your website. Ready to use components available also for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inferno.",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "bundles/basic"
+  },
+  "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"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/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",
+  "module": "esm/index.js",
+  "jsdelivr": "tsparticles.basic.bundle.min.js",
+  "unpkg": "tsparticles.basic.bundle.min.js",
+  "types": "types/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.0",
+    "@tsparticles/move-base": "^3.0.0-beta.0",
+    "@tsparticles/shape-circle": "^3.0.0-beta.0",
+    "@tsparticles/updater-color": "^3.0.0-beta.0",
+    "@tsparticles/updater-opacity": "^3.0.0-beta.0",
+    "@tsparticles/updater-out-modes": "^3.0.0-beta.0",
+    "@tsparticles/updater-size": "^3.0.0-beta.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}