@tsparticles/shape-text 3.0.0-alpha.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,71 @@
+[![banner](https://particles.js.org/images/banner2.png)](https://particles.js.org)
+
+# tsParticles Text Shape
+
+[![jsDelivr](https://data.jsdelivr.com/v1/package/npm/tsparticles-shape-text/badge)](https://www.jsdelivr.com/package/npm/tsparticles-shape-text)
+[![npmjs](https://badge.fury.io/js/tsparticles-shape-text.svg)](https://www.npmjs.com/package/tsparticles-shape-text)
+[![npmjs](https://img.shields.io/npm/dt/tsparticles-shape-text)](https://www.npmjs.com/package/tsparticles-shape-text) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
+
+[tsParticles](https://github.com/matteobruni/tsparticles) additional text shape.
+
+## How to use it
+
+### CDN / Vanilla JS / jQuery
+
+The CDN/Vanilla version JS has one required file in vanilla configuration:
+
+Including the `tsparticles.shape.text.min.js` file will export the function to load the shape:
+
+```javascript
+loadTextShape;
+```
+
+### Usage
+
+Once the scripts are loaded you can set up `tsParticles` and the shape like this:
+
+```javascript
+(async () => {
+  await loadTextShape();
+
+  await tsParticles.load({
+    id: "tsparticles",
+    options: {
+      /* options */
+      /* here you can use particles.shape.type: "text" */
+    },
+  });
+})();
+```
+
+### ESM / CommonJS
+
+This package is compatible also with ES or CommonJS modules, firstly this needs to be installed, like this:
+
+```shell
+$ npm install tsparticles-shape-text
+```
+
+or
+
+```shell
+$ yarn add tsparticles-shape-text
+```
+
+Then you need to import it in the app, like this:
+
+```javascript
+const { tsParticles } = require("tsparticles-engine");
+const { loadTextShape } = require("tsparticles-shape-text");
+
+loadTextShape(tsParticles);
+```
+
+or
+
+```javascript
+import { tsParticles } from "tsparticles-engine";
+import { loadTextShape } from "tsparticles-shape-text";
+
+loadTextShape(tsParticles);
+```

package/browser/ICharacterShape.js

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

package/browser/TextDrawer.js

@@ -0,0 +1,48 @@
+import { executeOnSingleOrMultiple, isInArray, itemFromSingleOrMultiple, loadFont } from "@tsparticles/engine";
+export const validTypes = ["text", "character", "char"];
+export class TextDrawer {
+    draw(context, particle, radius, opacity) {
+        var _a, _b, _c;
+        const character = particle.shapeData;
+        if (character === undefined) {
+            return;
+        }
+        const textData = character.value;
+        if (textData === undefined) {
+            return;
+        }
+        const textParticle = particle;
+        if (textParticle.text === undefined) {
+            textParticle.text = itemFromSingleOrMultiple(textData, particle.randomIndexData);
+        }
+        const text = textParticle.text, style = (_a = character.style) !== null && _a !== void 0 ? _a : "", weight = (_b = character.weight) !== null && _b !== void 0 ? _b : "400", size = Math.round(radius) * 2, font = (_c = character.font) !== null && _c !== void 0 ? _c : "Verdana", fill = particle.fill, offsetX = (text.length * radius) / 2;
+        context.font = `${style} ${weight} ${size}px "${font}"`;
+        const pos = {
+            x: -offsetX,
+            y: radius / 2,
+        };
+        context.globalAlpha = opacity;
+        if (fill) {
+            context.fillText(text, pos.x, pos.y);
+        }
+        else {
+            context.strokeText(text, pos.x, pos.y);
+        }
+        context.globalAlpha = 1;
+    }
+    getSidesCount() {
+        return 12;
+    }
+    async init(container) {
+        const options = container.actualOptions;
+        if (validTypes.find((t) => isInArray(t, options.particles.shape.type))) {
+            const shapeOptions = validTypes
+                .map((t) => options.particles.shape.options[t])
+                .find((t) => !!t), promises = [];
+            executeOnSingleOrMultiple(shapeOptions, (shape) => {
+                promises.push(loadFont(shape.font, shape.weight));
+            });
+            await Promise.all(promises);
+        }
+    }
+}

package/browser/TextParticle.js

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

package/browser/index.js

@@ -0,0 +1,4 @@
+import { TextDrawer, validTypes } from "./TextDrawer";
+export async function loadTextShape(engine) {
+    await engine.addShape(validTypes, new TextDrawer());
+}

package/cjs/ICharacterShape.js

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

package/cjs/TextDrawer.js

@@ -0,0 +1,63 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextDrawer = exports.validTypes = void 0;
+const engine_1 = require("@tsparticles/engine");
+exports.validTypes = ["text", "character", "char"];
+class TextDrawer {
+    draw(context, particle, radius, opacity) {
+        var _a, _b, _c;
+        const character = particle.shapeData;
+        if (character === undefined) {
+            return;
+        }
+        const textData = character.value;
+        if (textData === undefined) {
+            return;
+        }
+        const textParticle = particle;
+        if (textParticle.text === undefined) {
+            textParticle.text = (0, engine_1.itemFromSingleOrMultiple)(textData, particle.randomIndexData);
+        }
+        const text = textParticle.text, style = (_a = character.style) !== null && _a !== void 0 ? _a : "", weight = (_b = character.weight) !== null && _b !== void 0 ? _b : "400", size = Math.round(radius) * 2, font = (_c = character.font) !== null && _c !== void 0 ? _c : "Verdana", fill = particle.fill, offsetX = (text.length * radius) / 2;
+        context.font = `${style} ${weight} ${size}px "${font}"`;
+        const pos = {
+            x: -offsetX,
+            y: radius / 2,
+        };
+        context.globalAlpha = opacity;
+        if (fill) {
+            context.fillText(text, pos.x, pos.y);
+        }
+        else {
+            context.strokeText(text, pos.x, pos.y);
+        }
+        context.globalAlpha = 1;
+    }
+    getSidesCount() {
+        return 12;
+    }
+    init(container) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const options = container.actualOptions;
+            if (exports.validTypes.find((t) => (0, engine_1.isInArray)(t, options.particles.shape.type))) {
+                const shapeOptions = exports.validTypes
+                    .map((t) => options.particles.shape.options[t])
+                    .find((t) => !!t), promises = [];
+                (0, engine_1.executeOnSingleOrMultiple)(shapeOptions, (shape) => {
+                    promises.push((0, engine_1.loadFont)(shape.font, shape.weight));
+                });
+                yield Promise.all(promises);
+            }
+        });
+    }
+}
+exports.TextDrawer = TextDrawer;

package/cjs/TextParticle.js

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

package/cjs/index.js

@@ -0,0 +1,19 @@
+"use strict";
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadTextShape = void 0;
+const TextDrawer_1 = require("./TextDrawer");
+function loadTextShape(engine) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield engine.addShape(TextDrawer_1.validTypes, new TextDrawer_1.TextDrawer());
+    });
+}
+exports.loadTextShape = loadTextShape;

package/esm/ICharacterShape.js

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

package/esm/TextDrawer.js

@@ -0,0 +1,48 @@
+import { executeOnSingleOrMultiple, isInArray, itemFromSingleOrMultiple, loadFont } from "@tsparticles/engine";
+export const validTypes = ["text", "character", "char"];
+export class TextDrawer {
+    draw(context, particle, radius, opacity) {
+        var _a, _b, _c;
+        const character = particle.shapeData;
+        if (character === undefined) {
+            return;
+        }
+        const textData = character.value;
+        if (textData === undefined) {
+            return;
+        }
+        const textParticle = particle;
+        if (textParticle.text === undefined) {
+            textParticle.text = itemFromSingleOrMultiple(textData, particle.randomIndexData);
+        }
+        const text = textParticle.text, style = (_a = character.style) !== null && _a !== void 0 ? _a : "", weight = (_b = character.weight) !== null && _b !== void 0 ? _b : "400", size = Math.round(radius) * 2, font = (_c = character.font) !== null && _c !== void 0 ? _c : "Verdana", fill = particle.fill, offsetX = (text.length * radius) / 2;
+        context.font = `${style} ${weight} ${size}px "${font}"`;
+        const pos = {
+            x: -offsetX,
+            y: radius / 2,
+        };
+        context.globalAlpha = opacity;
+        if (fill) {
+            context.fillText(text, pos.x, pos.y);
+        }
+        else {
+            context.strokeText(text, pos.x, pos.y);
+        }
+        context.globalAlpha = 1;
+    }
+    getSidesCount() {
+        return 12;
+    }
+    async init(container) {
+        const options = container.actualOptions;
+        if (validTypes.find((t) => isInArray(t, options.particles.shape.type))) {
+            const shapeOptions = validTypes
+                .map((t) => options.particles.shape.options[t])
+                .find((t) => !!t), promises = [];
+            executeOnSingleOrMultiple(shapeOptions, (shape) => {
+                promises.push(loadFont(shape.font, shape.weight));
+            });
+            await Promise.all(promises);
+        }
+    }
+}

package/esm/TextParticle.js

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

package/esm/index.js

@@ -0,0 +1,4 @@
+import { TextDrawer, validTypes } from "./TextDrawer";
+export async function loadTextShape(engine) {
+    await engine.addShape(validTypes, new TextDrawer());
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@tsparticles/shape-text",
+  "version": "3.0.0-alpha.0",
+  "description": "tsParticles text shape",
+  "homepage": "https://particles.js.org",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/matteobruni/tsparticles.git",
+    "directory": "shapes/text"
+  },
+  "keywords": [
+    "front-end",
+    "frontend",
+    "tsparticles",
+    "particles",
+    "particle",
+    "canvas",
+    "jsparticles",
+    "xparticles",
+    "particles-js",
+    "particles.js",
+    "particles-ts",
+    "particles.ts",
+    "typescript",
+    "javascript",
+    "animation",
+    "web",
+    "html5",
+    "web-design",
+    "webdesign",
+    "css",
+    "html",
+    "css3",
+    "animated",
+    "background",
+    "@tsparticles/shape"
+  ],
+  "author": "Matteo Bruni <matteo.bruni@me.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/matteobruni/tsparticles/issues"
+  },
+  "main": "cjs/index.js",
+  "jsdelivr": "tsparticles.shape.text.min.js",
+  "unpkg": "tsparticles.shape.text.min.js",
+  "module": "esm/index.js",
+  "types": "types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tsparticles/engine": "^3.0.0-alpha.0"
+  }
+}