@supermousejs/trail 2.3.0 → 2.3.1

package/README.md

@@ -1,6 +1,6 @@
 # @supermousejs/trail
 
-Generates a procedural particle trail that follows the cursor.
+Generates procedural particles that trail behind your motion.
 
 ## Installation
 
@@ -8,23 +8,27 @@ Generates a procedural particle trail that follows the cursor.
 pnpm add @supermousejs/trail
 ```
 
-## Usage
+## Trail
+
+Generates procedural particles that trail behind your motion.
+
+### Usage
 
 ```ts
 import { Supermouse } from "@supermousejs/core";
 import { Trail } from "@supermousejs/trail";
-
 const app = new Supermouse();
-
-app.use(
-  Trail({
-    length: 10, // Number of segments
-    size: 6, // Particle size
-    color: "#ff00ff"
-  })
-);
+app.use(Trail({ length: 12, color: '#f0f' }));
 ```
 
+### Options
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| length | number | 10 | Number of trail segments. |
+| size | number | 6 | Size of trail particles. |
+| color | string | '#ff00ff' | Color of segments. |
+
 ## Documentation
 
 Full documentation and interactive playground available at [supermouse](https://supermouse.js.org) or [check out the repo](https://github.com/Whitestar14/supermouse-js).

package/package.json

@@ -1,20 +1,24 @@
 {
   "name": "@supermousejs/trail",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "author": "O.S David",
   "url": "https://github.com/Whitestar14/supermouse-js",
   "license": "MIT",
   "dependencies": {
-    "@supermousejs/utils": "2.3.0"
+    "@supermousejs/utils": "2.3.1"
   },
   "devDependencies": {
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.3.0"
   },
   "peerDependencies": {
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.3.0"
   },
   "repository": {
     "type": "git",

package/CHANGELOG.md

@@ -1,96 +0,0 @@
-# @supermousejs/trail
-
-## 2.3.0
-
-### Patch Changes
-
-- Updated dependencies [f6f44b2]
-  - @supermousejs/core@2.2.0
-  - @supermousejs/utils@2.3.0
-
-## 2.2.1
-
-### Patch Changes
-
-- a72f5a3: bugfix: fixed a type declaration issue from missing `return` keyword with the Trail package export
-
-## 2.2.0
-
-### Patch Changes
-
-- 6d70c18: remove legacy package and update supermouse domain in readme
-- 14fb5b6: Updated tsconfig to be reference-compliant with core, utils and zoetrope when required
-- Updated dependencies [6d70c18]
-- Updated dependencies [2590af3]
-- Updated dependencies [14fb5b6]
-- Updated dependencies [9fe1a7b]
-- Updated dependencies [9fa6ece]
-  - @supermousejs/core@2.1.0
-  - @supermousejs/utils@2.2.0
-
-## 2.1.1
-
-### Patch Changes
-
-- 67f771b: Add relevant npm metadata to package.json file
-- Updated dependencies [67f771b]
-  - @supermousejs/utils@2.1.1
-  - @supermousejs/core@2.0.5
-
-## 2.1.0
-
-### Minor Changes
-
-- 0a1652d: fixed build architecture and updated plugin metadata
-
-### Patch Changes
-
-- Updated dependencies [0a1652d]
-  - @supermousejs/utils@2.1.0
-
-## 2.0.4
-
-### Patch Changes
-
-- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
-- Updated dependencies [993dc67]
-  - @supermousejs/utils@2.0.4
-  - @supermousejs/core@2.0.4
-
-## 2.0.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.3
-  - @supermousejs/utils@2.0.3
-
-## 2.0.2
-
-### Patch Changes
-
-- ae219a0: Update READMEs with correct link to documentation
-- Updated dependencies [ae219a0]
-  - @supermousejs/utils@2.0.2
-  - @supermousejs/core@2.0.2
-
-## 2.0.1
-
-### Patch Changes
-
-- Add minimal README.md files to packages
-- Updated dependencies
-  - @supermousejs/utils@2.0.1
-  - @supermousejs/core@2.0.1
-
-## 2.0.0
-
-### Major Changes
-
-- Initial v2.0.0 release
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/utils@2.0.0
-  - @supermousejs/core@2.0.0

package/meta.json

@@ -1,32 +0,0 @@
-{
-  "id": "trail",
-  "name": "Trail",
-  "package": "@supermousejs/trail",
-  "description": "Generates procedural particles that trail behind your motion.",
-  "code": "app.use(Trail({ length: 12, color: '#f0f' }));",
-  "recipeId": "ghost-trail",
-  "icon": "trail",
-  "options": [
-    {
-      "name": "length",
-      "type": "number",
-      "default": "10",
-      "description": "Number of trail segments.",
-      "reactive": false
-    },
-    {
-      "name": "size",
-      "type": "number",
-      "default": "6",
-      "description": "Size of trail particles.",
-      "reactive": true
-    },
-    {
-      "name": "color",
-      "type": "string",
-      "default": "'#ff00ff'",
-      "description": "Color of segments.",
-      "reactive": true
-    }
-  ]
-}

package/src/index.ts

@@ -1,66 +0,0 @@
-import type { ValueOrGetter, Supermouse } from "@supermousejs/core";
-import { definePlugin, normalize, dom, Layers } from "@supermousejs/utils";
-
-export interface TrailOptions {
-  name?: string;
-  isEnabled?: boolean;
-  length?: number;
-  size?: ValueOrGetter<number>;
-  color?: ValueOrGetter<string>;
-}
-
-export const Trail = (options: TrailOptions = {}) => {
-  const length = options.length || 10;
-  const getSize = normalize(options.size, 6);
-  const getColor = normalize(options.color, "#ff00ff");
-
-  const segments: HTMLDivElement[] = [];
-  const history: { x: number; y: number }[] = [];
-
-  return definePlugin<HTMLDivElement, TrailOptions>(
-    {
-      name: options.name || "trail",
-
-      create: () => {
-        segments.length = 0;
-        history.length = 0;
-        const container = dom.createActor("div") as HTMLDivElement;
-        container.style.zIndex = Layers.TRACE;
-
-        for (let i = 0; i < length; i++) {
-          const d = dom.createCircle(0, "#000");
-          d.style.position = "absolute";
-          d.style.opacity = String(1 - i / length);
-          container.appendChild(d);
-          segments.push(d);
-          history.push({ x: -100, y: -100 });
-        }
-        return container;
-      },
-
-      update: (app: Supermouse) => {
-        const { x, y } = app.state.smooth;
-
-        // Shift history
-        history.pop();
-        history.unshift({ x, y });
-
-        const baseSize = getSize(app.state);
-        const color = getColor(app.state);
-
-        segments.forEach((seg, i) => {
-          const pos = history[i];
-          const scale = 1 - i / length;
-          const size = baseSize * scale;
-
-          dom.setStyle(seg, "width", `${size}px`);
-          dom.setStyle(seg, "height", `${size}px`);
-          dom.setStyle(seg, "backgroundColor", color);
-
-          dom.setTransform(seg, pos.x, pos.y);
-        });
-      }
-    },
-    options
-  );
-};

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.plugin.json",
-  "include": ["src"]
-}

package/vite.config.ts

@@ -1,23 +0,0 @@
-import { defineConfig } from "vite";
-import dts from "vite-plugin-dts";
-import path from "path";
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: path.resolve(__dirname, "src/index.ts"),
-      name: "SupermouseTrail",
-      fileName: (format) => (format === "es" ? "index.mjs" : "index.umd.js")
-    },
-    rollupOptions: {
-      external: ["@supermousejs/core", "@supermousejs/utils"],
-      output: {
-        globals: {
-          "@supermousejs/core": "SupermouseCore",
-          "@supermousejs/utils": "SupermouseUtils"
-        }
-      }
-    }
-  },
-  plugins: [dts({ rollupTypes: true })]
-});