tsparticles 2.0.0-beta.2 → 2.0.0-beta.3

package/107.js

@@ -4,7 +4,7 @@
  * Demo / Generator : https://particles.js.org/
  * GitHub : https://www.github.com/matteobruni/tsparticles
  * How to use? : Check the GitHub README
- * v2.0.0-beta.2
+ * v2.0.0-beta.3
  */
 "use strict";
 (this["webpackChunktsparticles"] = this["webpackChunktsparticles"] || []).push([[107],{

package/README.md

@@ -1,92 +1,87 @@
 [![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
 
-# tsParticles Bubbles Preset
+# tsParticles Full Bundle
 
-[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-preset-bubbles/badge)](https://www.jsdelivr.com/package/npm/tsparticles) [![npmjs](https://badge.fury.io/js/tsparticles-preset-bubbles.svg)](https://www.npmjs.com/package/tsparticles-preset-bubbles) [![npmjs](https://img.shields.io/npm/dt/tsparticles-preset-bubbles)](https://www.npmjs.com/package/tsparticles-preset-bubbles)
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles/badge)](https://www.jsdelivr.com/package/npm/tsparticles) [![npmjs](https://badge.fury.io/js/tsparticles.svg)](https://www.npmjs.com/package/tsparticles) [![npmjs](https://img.shields.io/npm/dt/tsparticles)](https://www.npmjs.com/package/tsparticles)
 
-[tsParticles](https://github.com/matteobruni/tsparticles) preset for colored bubbles coming from the bottom of the
-screen on a white background.
+[tsParticles](https://github.com/matteobruni/tsparticles) full bundle loads all the v1 features to
+a `tsparticles-engine` instance.
 
-## Sample
+**Included Packages**
 
-![demo](https://raw.githubusercontent.com/matteobruni/tsparticles/v1/presets/bubbles/images/sample.png)
+- tsparticles-engine
+- tsparticles-slim (and all its dependencies)
+- tsparticles-interaction-external-trail
+- tsparticles-plugin-absorbers
+- tsparticles-plugin-emitters
+- tsparticles-plugin-polygon-mask
+- tsparticles-updater-roll
+- tsparticles-updater-tilt
+- tsparticles-updater-wobble
 
 ## 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)
+The CDN/Vanilla version JS has two different files:
 
-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-bubbles):
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/tsparticles"></script>
-<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-bubbles"></script>
-```
-
-This script **MUST** be placed after the `tsParticles` one.
+- One is a bundle file with all the scripts included in a single file
+- One is a file including just the `loadFull` function to load the tsParticles full preset, all dependencies must be
+  included manually
 
 #### Bundle
 
-A bundled script can also be used, this will include every needed plugin needed by the preset.
+Including the `tsparticles.bundle.min.js` file will work exactly like `v1`, you can start using the `tsParticles`
+instance in the same way.
 
-```html
-<script src="https://cdn.jsdelivr.net/npm/tsparticles-preset-bubbles/dist/tsparticles.preset.bubbles.bundle.min.js"></script>
-```
+This is the easiest usage, since it's a single file with the same `v1` features.
 
-### Usage
+All new features will be added as external packages, this bundle is recommended for migrating from `v1` easily.
 
-Once the scripts are loaded you can set up `tsParticles` like this:
+#### Not Bundle
 
-```javascript
-loadBubblesPreset(tsParticles);
+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.
 
-tsParticles.load("tsparticles", {
-  preset: "bubbles",
-});
-```
+A note about `tsparticles-slim` can be made: it's not mandatory to include all of its dependencies, the slim bundle file
+is enough, and if this is done the `tsparticles-engine` is not needed, since it's already bundled in the slim bundle.
 
-#### Customization
+### Usage
 
-**Important ⚠️**
-You can override all the options defining the properties like in any standard `tsParticles` installation.
+Once the scripts are loaded you can set up `tsParticles` like this:
 
 ```javascript
+loadFull(tsParticles); // not needed if using the bundle script, required for any other installation
+
 tsParticles.load("tsparticles", {
-  particles: {
-    shape: {
-      type: "square",
-    },
-  },
-  preset: "bubbles",
+  /* options */
 });
 ```
 
-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).
 
-```javascript
+_Class Components_
+
+```typescript jsx
+import React from "react";
 import Particles from "react-tsparticles";
-import { Main } from "tsparticles-engine";
-import { loadBubblesPreset } from "tsparticles-preset-bubbles";
+import type { Main } from "tsparticles-engine";
+import { loadFull } from "tsparticles";
 
-export class ParticlesContainer extends React.PureComponent<IProps> {
+export class ParticlesContainer extends PureComponent<unknown> {
   // this customizes the component tsParticles installation
   customInit(main: Main) {
-    // this adds the preset to tsParticles, you can safely use the
-    loadBubblesPreset(main);
+    // this adds the bundle to tsParticles
+    loadFull(main);
   }
 
   render() {
     const options = {
-      preset: "bubbles",
+      /* custom options */
     };
 
     return <Particles options={options} init={this.customInit} />;
@@ -94,6 +89,29 @@ export class ParticlesContainer extends React.PureComponent<IProps> {
 }
 ```
 
+_Hooks / Functional Components_
+
+```typescript jsx
+import React, { useCallback } from "react";
+import Particles from "react-tsparticles";
+import type { Main } from "tsparticles-engine";
+import { loadFull } from "tsparticles";
+
+export function ParticlesContainer(props: unknown) {
+  // this customizes the component tsParticles installation
+  const customInit = useCallback((main: Main) => {
+    // this adds the bundle to tsParticles
+    loadFull(main);
+  });
+
+  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_
@@ -104,7 +122,7 @@ _The syntax for `Vue.js 2.x` and `3.x` is the same_
 
 ```js
 function particlesInit(main: Main) {
-  loadBubblesPreset(main);
+  loadFull(main);
 }
 ```
 
@@ -121,7 +139,7 @@ function particlesInit(main: Main) {
 
 ```ts
 function particlesInit(main: Main): void {
-  loadBubblesPreset(main);
+  loadFull(main);
 }
 ```
 
@@ -138,6 +156,6 @@ function particlesInit(main: Main): void {
 
 ```js
 let onParticlesInit = (main) => {
-  loadBubblesPreset(main);
+  loadFull(main);
 };
 ```

package/index.d.ts

@@ -1,2 +1,2 @@
 import type { Main } from "tsparticles-engine";
-export declare function loadFull(tsParticles: Main): void;
+export declare function loadFull(tsParticles: Main): Promise<void>;

package/index.js

@@ -1,12 +1,29 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { loadSlim } from "tsparticles-slim";
+import { loadTiltUpdater } from "tsparticles-updater-tilt";
+import { loadRollUpdater } from "tsparticles-updater-roll";
+import { loadWobbleUpdater } from "tsparticles-updater-wobble";
 import { loadExternalTrailInteraction } from "tsparticles-interaction-external-trail";
 import { loadAbsorbersPlugin } from "tsparticles-plugin-absorbers";
 import { loadEmittersPlugin } from "tsparticles-plugin-emitters";
 import { loadPolygonMaskPlugin } from "tsparticles-plugin-polygon-mask";
 export function loadFull(tsParticles) {
-    loadSlim(tsParticles);
-    loadExternalTrailInteraction(tsParticles);
-    loadAbsorbersPlugin(tsParticles);
-    loadEmittersPlugin(tsParticles);
-    loadPolygonMaskPlugin(tsParticles);
+    return __awaiter(this, void 0, void 0, function* () {
+        yield loadSlim(tsParticles);
+        yield loadTiltUpdater(tsParticles);
+        yield loadRollUpdater(tsParticles);
+        yield loadWobbleUpdater(tsParticles);
+        yield loadExternalTrailInteraction(tsParticles);
+        yield loadAbsorbersPlugin(tsParticles);
+        yield loadEmittersPlugin(tsParticles);
+        yield loadPolygonMaskPlugin(tsParticles);
+    });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tsparticles",
-  "version": "2.0.0-beta.2",
+  "version": "2.0.0-beta.3",
   "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/",
   "scripts": {
@@ -9,7 +9,7 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/matteobruni/tsparticles.git",
-    "directory": "core/main"
+    "directory": "bundles/full"
   },
   "keywords": [
     "tsparticles",
@@ -51,11 +51,6 @@
     "background"
   ],
   "author": "Matteo Bruni <matteo.bruni@me.com>",
-  "contributors": [
-    "Gabriel Barker (https://github.com/gabrielbarker)",
-    "Tyler Burnett (https://github.com/TylerBurnett)",
-    "Jonathan Adams (https://github.com/PieceMaker)"
-  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/matteobruni/tsparticles/issues"
@@ -71,11 +66,14 @@
   "browser": "index.js",
   "types": "index.d.ts",
   "dependencies": {
-    "tsparticles-engine": "^2.0.0-beta.1",
-    "tsparticles-interaction-external-trail": "^2.0.0-beta.2",
-    "tsparticles-plugin-absorbers": "^2.0.0-beta.2",
-    "tsparticles-plugin-emitters": "^2.0.0-beta.2",
-    "tsparticles-plugin-polygon-mask": "^2.0.0-beta.2",
-    "tsparticles-slim": "^2.0.0-beta.2"
+    "tsparticles-engine": "^2.0.0-beta.2",
+    "tsparticles-interaction-external-trail": "^2.0.0-beta.3",
+    "tsparticles-plugin-absorbers": "^2.0.0-beta.3",
+    "tsparticles-plugin-emitters": "^2.0.0-beta.3",
+    "tsparticles-plugin-polygon-mask": "^2.0.0-beta.3",
+    "tsparticles-slim": "^2.0.0-beta.3",
+    "tsparticles-updater-roll": "^2.0.0-beta.3",
+    "tsparticles-updater-tilt": "^2.0.0-beta.3",
+    "tsparticles-updater-wobble": "^2.0.0-beta.3"
   }
 }