@supermousejs/magnetic 2.3.0 → 2.4.0

package/README.md

@@ -1,6 +1,6 @@
 # @supermousejs/magnetic
 
-A **Logic Plugin** that attracts the cursor to interactive elements.
+Attracts the cursor to interactive elements using physics-based magnetism.
 
 ## Installation
 
@@ -8,28 +8,25 @@ A **Logic Plugin** that attracts the cursor to interactive elements.
 pnpm add @supermousejs/magnetic
 ```
 
-## Usage
+## Magnetic
+
+Attracts the cursor to interactive elements using physics-based magnetism.
+
+### Usage
 
 ```ts
 import { Supermouse } from "@supermousejs/core";
 import { Magnetic } from "@supermousejs/magnetic";
-
 const app = new Supermouse();
-
-// Priority is handled automatically (-10)
-app.use(
-  Magnetic({
-    attraction: 0.3, // Strength (0-1)
-    distance: 100 // Capture radius in px
-  })
-);
+app.use(Magnetic({ attraction: 0.4, distance: 100 }));
 ```
 
-**HTML:**
+### Options
 
-```html
-<button data-supermouse-magnetic="true">Magnetic Button</button>
-```
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| attraction | number | 0.3 | Strength of the pull (0-1). |
+| distance | number | 100 | Radius in pixels where attraction begins. |
 
 ## Documentation
 

package/package.json

@@ -1,20 +1,25 @@
 {
   "name": "@supermousejs/magnetic",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "description": "Attracts the cursor to interactive elements using physics-based magnetism.",
+  "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.4.0"
   },
   "devDependencies": {
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.4.0"
   },
   "peerDependencies": {
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.4.0"
   },
   "repository": {
     "type": "git",

package/CHANGELOG.md

@@ -1,90 +0,0 @@
-# @supermousejs/magnetic
-
-## 2.3.0
-
-### Patch Changes
-
-- Updated dependencies [f6f44b2]
-  - @supermousejs/core@2.2.0
-  - @supermousejs/utils@2.3.0
-
-## 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,25 +0,0 @@
-{
-  "id": "magnetic",
-  "name": "Magnetic",
-  "package": "@supermousejs/magnetic",
-  "description": "Attracts the cursor to interactive elements using physics-based magnetism.",
-  "code": "app.use(Magnetic({ attraction: 0.4, distance: 100 }));",
-  "recipeId": "magnetic-button",
-  "icon": "magnetic",
-  "options": [
-    {
-      "name": "attraction",
-      "type": "number",
-      "default": "0.3",
-      "description": "Strength of the pull (0-1).",
-      "reactive": true
-    },
-    {
-      "name": "distance",
-      "type": "number",
-      "default": "100",
-      "description": "Radius in pixels where attraction begins.",
-      "reactive": true
-    }
-  ]
-}

package/src/index.ts

@@ -1,59 +0,0 @@
-import type { ValueOrGetter } from "@supermousejs/core";
-import { definePlugin, normalize, math, dom } from "@supermousejs/utils";
-
-export interface MagneticOptions {
-  name?: string;
-  isEnabled?: boolean;
-  attraction?: ValueOrGetter<number>;
-  distance?: ValueOrGetter<number>;
-}
-
-export const Magnetic = (options: MagneticOptions = {}) => {
-  let lastTarget: HTMLElement | null = null;
-  const magnetCenter = { x: 0, y: 0 };
-  let isActive = false;
-
-  const getAttraction = normalize(options.attraction, 0.3);
-  const getDistance = normalize(options.distance, 100);
-
-  return definePlugin(
-    {
-      name: "magnetic",
-      priority: -10,
-
-      install(app) {
-        app.registerHoverTarget("[data-supermouse-magnetic]");
-      },
-
-      update(app) {
-        const target = app.state.hoverTarget;
-        const val = app.state.interaction.magnetic;
-        const isMagnetic = val === true || val === "true" || (typeof val === "number" && val > 0);
-
-        if (isMagnetic && target !== lastTarget) {
-          lastTarget = target!;
-          const rect = dom.projectRect(target!, app.container);
-          magnetCenter.x = rect.left + rect.width / 2;
-          magnetCenter.y = rect.top + rect.height / 2;
-          isActive = true;
-        } else if (!isMagnetic && lastTarget) {
-          lastTarget = null;
-          isActive = false;
-        }
-
-        if (isActive && lastTarget) {
-          const { x, y } = app.state.pointer;
-          const dist = math.dist(x, y, magnetCenter.x, magnetCenter.y);
-          const range = getDistance(app.state);
-
-          if (dist < range) {
-            const attraction = typeof val === "number" ? val : getAttraction(app.state);
-            app.state.target.x = math.lerp(x, magnetCenter.x, attraction);
-            app.state.target.y = math.lerp(y, magnetCenter.y, attraction);
-          }
-        }
-      }
-    },
-    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: "SupermouseMagnetic",
-      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 })]
-});