@tsparticles/plugin-export-image 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,74 @@
+[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)
+
+# tsParticles Export Image Plugin
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/@tsparticles/plugin-export-image/badge)](https://www.jsdelivr.com/package/npm/@tsparticles/plugin-export-image)
+[![npmjs](https://badge.fury.io/js/@tsparticles/plugin-export-image.svg)](https://www.npmjs.com/package/@tsparticles/plugin-export-image)
+[![npmjs](https://img.shields.io/npm/dt/@tsparticles/plugin-export-image)](https://www.npmjs.com/package/@tsparticles/plugin-export-image) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) plugin for adding the export image support.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.plugin.export.image.min.js` file will export the function to load the plugin:
+
+```text
+loadExportImagePlugin
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the plugin like this:
+
+```javascript
+(async () => {
+  await loadExportImagePlugin();
+
+  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:
+
+```shell
+$ npm install @tsparticles/plugin-export-image
+```
+
+or
+
+```shell
+$ yarn add @tsparticles/plugin-export-image
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("@tsparticles/engine");
+const { loadExportImagePlugin } = require("@tsparticles/plugin-export-image");
+
+(async () => {
+  await loadExportImagePlugin();
+})();
+```
+
+or
+
+```javascript
+import { tsParticles } from "@tsparticles/engine";
+import { loadExportImagePlugin } from "@tsparticles/plugin-export-image";
+
+(async () => {
+  await loadExportImagePlugin();
+})();
+```

package/browser/ExportImageInstance.js

@@ -0,0 +1,33 @@
+export class ExportImageInstance {
+    constructor(container, engine) {
+        this._exportImage = async (data) => {
+            const element = this._container.canvas.element;
+            if (!element) {
+                return;
+            }
+            return new Promise((resolve) => {
+                element.toBlob((blob) => {
+                    if (!blob) {
+                        resolve(undefined);
+                        return;
+                    }
+                    resolve(blob);
+                }, data.type ?? "image/png", data.quality);
+            });
+        };
+        this._container = container;
+        this._engine = engine;
+    }
+    async export(type, data) {
+        const res = {
+            supported: false,
+        };
+        switch (type) {
+            case "image":
+                res.supported = true;
+                res.blob = await this._exportImage(data);
+                break;
+        }
+        return res;
+    }
+}

package/browser/IExportImageData.js

@@ -0,0 +1 @@
+export {};

package/browser/index.js

@@ -0,0 +1,18 @@
+import { ExportImageInstance } from "./ExportImageInstance";
+class ExportImagePlugin {
+    constructor(engine) {
+        this.id = "export-image";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new ExportImageInstance(container, this._engine);
+    }
+    loadOptions() {
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+export async function loadExportImagePlugin(engine, refresh = true) {
+    await engine.addPlugin(new ExportImagePlugin(engine), refresh);
+}

package/cjs/ExportImageInstance.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExportImageInstance = void 0;
+class ExportImageInstance {
+    constructor(container, engine) {
+        this._exportImage = async (data) => {
+            const element = this._container.canvas.element;
+            if (!element) {
+                return;
+            }
+            return new Promise((resolve) => {
+                element.toBlob((blob) => {
+                    if (!blob) {
+                        resolve(undefined);
+                        return;
+                    }
+                    resolve(blob);
+                }, data.type ?? "image/png", data.quality);
+            });
+        };
+        this._container = container;
+        this._engine = engine;
+    }
+    async export(type, data) {
+        const res = {
+            supported: false,
+        };
+        switch (type) {
+            case "image":
+                res.supported = true;
+                res.blob = await this._exportImage(data);
+                break;
+        }
+        return res;
+    }
+}
+exports.ExportImageInstance = ExportImageInstance;

package/cjs/IExportImageData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadExportImagePlugin = void 0;
+const ExportImageInstance_1 = require("./ExportImageInstance");
+class ExportImagePlugin {
+    constructor(engine) {
+        this.id = "export-image";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new ExportImageInstance_1.ExportImageInstance(container, this._engine);
+    }
+    loadOptions() {
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+async function loadExportImagePlugin(engine, refresh = true) {
+    await engine.addPlugin(new ExportImagePlugin(engine), refresh);
+}
+exports.loadExportImagePlugin = loadExportImagePlugin;

package/esm/ExportImageInstance.js

@@ -0,0 +1,33 @@
+export class ExportImageInstance {
+    constructor(container, engine) {
+        this._exportImage = async (data) => {
+            const element = this._container.canvas.element;
+            if (!element) {
+                return;
+            }
+            return new Promise((resolve) => {
+                element.toBlob((blob) => {
+                    if (!blob) {
+                        resolve(undefined);
+                        return;
+                    }
+                    resolve(blob);
+                }, data.type ?? "image/png", data.quality);
+            });
+        };
+        this._container = container;
+        this._engine = engine;
+    }
+    async export(type, data) {
+        const res = {
+            supported: false,
+        };
+        switch (type) {
+            case "image":
+                res.supported = true;
+                res.blob = await this._exportImage(data);
+                break;
+        }
+        return res;
+    }
+}

package/esm/IExportImageData.js

@@ -0,0 +1 @@
+export {};

package/esm/index.js

@@ -0,0 +1,18 @@
+import { ExportImageInstance } from "./ExportImageInstance";
+class ExportImagePlugin {
+    constructor(engine) {
+        this.id = "export-image";
+        this._engine = engine;
+    }
+    getPlugin(container) {
+        return new ExportImageInstance(container, this._engine);
+    }
+    loadOptions() {
+    }
+    needsPlugin() {
+        return true;
+    }
+}
+export async function loadExportImagePlugin(engine, refresh = true) {
+    await engine.addPlugin(new ExportImagePlugin(engine), refresh);
+}

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@tsparticles/plugin-export-image",
+  "version": "3.0.0-beta.0",
+  "description": "tsParticles export image plugin",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "plugins/exports/image"
+  },
+  "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/plugin"
+  ],
+  "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",
+  "jsdelivr": "tsparticles.plugin.export.image.min.js",
+  "unpkg": "tsparticles.plugin.export.image.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "sideEffects": false,
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-beta.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}