@supermousejs/stick 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -1,68 +1,82 @@
-# @supermousejs/stick
-
-## 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
+# @supermousejs/stick
+
+## 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/LICENSE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Sijibomi Olusunmbola
-
-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.
+MIT License
+
+Copyright (c) 2025 Sijibomi Olusunmbola
+
+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

@@ -1,33 +1,33 @@
-
-# @supermousejs/stick
-
-A **Logic Plugin** that calculates the bounding box of hovered elements.
-Used in combination with `@supermousejs/ring` (or SmartRing) to create a morphing effect.
-
-## Installation
-
-```bash
-pnpm add @supermousejs/stick
-```
-
-## Usage
-
-```ts
-import { Supermouse } from '@supermousejs/core';
-import { Stick } from '@supermousejs/stick';
-import { Ring } from '@supermousejs/ring';
-
-const app = new Supermouse();
-
-app.use(Stick({ padding: 10 }));
-app.use(Ring()); // Ring automatically detects 'stick' state and morphs
-```
-
-**HTML:**
-```html
-<button data-supermouse-stick="true">Sticky Element</button>
-```
-
-## Documentation
-
-Full documentation and interactive playground available at [supermouse](https://supermouse.vercel.app) or [check out the repo](https://github.com/Whitestar14/supermouse-js).
+# @supermousejs/stick
+
+A **Logic Plugin** that calculates the bounding box of hovered elements.
+Used in combination with `@supermousejs/ring` (or SmartRing) to create a morphing effect.
+
+## Installation
+
+```bash
+pnpm add @supermousejs/stick
+```
+
+## Usage
+
+```ts
+import { Supermouse } from "@supermousejs/core";
+import { Stick } from "@supermousejs/stick";
+import { Ring } from "@supermousejs/ring";
+
+const app = new Supermouse();
+
+app.use(Stick({ padding: 10 }));
+app.use(Ring()); // Ring automatically detects 'stick' state and morphs
+```
+
+**HTML:**
+
+```html
+<button data-supermouse-stick="true">Sticky Element</button>
+```
+
+## 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/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { SupermousePlugin } from '../../core/src/index.ts';
-import { ValueOrGetter } from '../../core/src/index.ts';
+import { SupermousePlugin } from '../../core/src';
+import { ValueOrGetter } from '../../core/src';
 
 export declare const Stick: (options?: StickOptions) => SupermousePlugin;
 

package/dist/index.mjs

@@ -2,36 +2,39 @@ import { normalize as c, definePlugin as h, dom as g } from "@supermousejs/utils
 const m = (a = {}) => {
   const d = c(a.padding, 10);
   let s = null, e = null;
-  return h({
-    name: a.name || "stick",
-    // Logic plugin: must run before visuals to set the shape state
-    priority: -10,
-    install(t) {
-      t.registerHoverTarget("[data-supermouse-stick]");
+  return h(
+    {
+      name: a.name || "stick",
+      // Logic plugin: must run before visuals to set the shape state
+      priority: -10,
+      install(t) {
+        t.registerHoverTarget("[data-supermouse-stick]");
+      },
+      update(t) {
+        const r = t.state.hoverTarget, l = t.state.interaction.stick === !0 || t.state.interaction.stick === "true";
+        if (r && l) {
+          if (r !== s || !e) {
+            s = r;
+            const i = g.projectRect(r, t.container), o = window.getComputedStyle(r), n = d(t.state);
+            e = {
+              width: i.width + n,
+              height: i.height + n,
+              radius: parseFloat(o.borderRadius) || 0,
+              x: i.left + i.width / 2,
+              y: i.top + i.height / 2
+            };
+          }
+          e && (t.state.target.x = e.x, t.state.target.y = e.y, t.state.shape = {
+            width: e.width,
+            height: e.height,
+            borderRadius: e.radius
+          });
+        } else
+          s && (s = null, e = null), t.state.shape = null;
+      }
     },
-    update(t) {
-      const r = t.state.hoverTarget, l = t.state.interaction.stick === !0 || t.state.interaction.stick === "true";
-      if (r && l) {
-        if (r !== s || !e) {
-          s = r;
-          const i = g.projectRect(r, t.container), o = window.getComputedStyle(r), n = d(t.state);
-          e = {
-            width: i.width + n,
-            height: i.height + n,
-            radius: parseFloat(o.borderRadius) || 0,
-            x: i.left + i.width / 2,
-            y: i.top + i.height / 2
-          };
-        }
-        e && (t.state.target.x = e.x, t.state.target.y = e.y, t.state.shape = {
-          width: e.width,
-          height: e.height,
-          borderRadius: e.radius
-        });
-      } else
-        s && (s = null, e = null), t.state.shape = null;
-    }
-  }, a);
+    a
+  );
 };
 export {
   m as Stick

package/meta.json

@@ -1,13 +1,18 @@
-
-{
-  "id": "stick",
-  "name": "Stick",
-  "package": "@supermousejs/stick",
-  "description": "Morphs the cursor shape to match the bounding box of hovered elements.",
-  "code": "app.use(Stick({ padding: 10 }));",
-  "recipeId": "sticky-element",
-  "icon": "stick",
-  "options": [
-    { "name": "padding", "type": "number", "default": "10", "description": "Extra padding around the target element in pixels.", "reactive": true }
-  ]
-}
+{
+  "id": "stick",
+  "name": "Stick",
+  "package": "@supermousejs/stick",
+  "description": "Morphs the cursor shape to match the bounding box of hovered elements.",
+  "code": "app.use(Stick({ padding: 10 }));",
+  "recipeId": "sticky-element",
+  "icon": "stick",
+  "options": [
+    {
+      "name": "padding",
+      "type": "number",
+      "default": "10",
+      "description": "Extra padding around the target element in pixels.",
+      "reactive": true
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@supermousejs/stick",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -8,13 +8,13 @@
   "url": "https://github.com/Whitestar14/supermouse-js",
   "license": "MIT",
   "dependencies": {
-    "@supermousejs/utils": "2.1.1"
+    "@supermousejs/utils": "2.2.0"
   },
   "devDependencies": {
-    "@supermousejs/core": "2.0.5"
+    "@supermousejs/core": "2.1.0"
   },
   "peerDependencies": {
-    "@supermousejs/core": "2.0.5"
+    "@supermousejs/core": "2.1.0"
   },
   "repository": {
     "type": "git",

package/src/index.ts

@@ -1,73 +1,75 @@
-
-import type { ValueOrGetter } from '@supermousejs/core';
-import { definePlugin, normalize, dom } from '@supermousejs/utils';
-
-export interface StickOptions {
-  name?: string;
-  isEnabled?: boolean;
-  /** Extra padding around the element when calculating shape. Default 10. */
-  padding?: ValueOrGetter<number>;
-}
-
-export const Stick = (options: StickOptions = {}) => {
-  const getPadding = normalize(options.padding, 10);
-  
-  let lastTarget: HTMLElement | null = null;
-  let cache: { width: number; height: number; radius: number; x: number; y: number } | null = null;
-
-  return definePlugin({
-    name: options.name || 'stick',
-    // Logic plugin: must run before visuals to set the shape state
-    priority: -10, 
-    
-    install(app) {
-      app.registerHoverTarget('[data-supermouse-stick]');
-    },
-
-    update(app) {
-      // Check normalized interaction key (camelCase, no prefix)
-      const target = app.state.hoverTarget;
-      const isSticky = app.state.interaction.stick === true || app.state.interaction.stick === 'true';
-      
-      if (target && isSticky) {
-        
-        // Recalculate only if target changed or on first frame
-        if (target !== lastTarget || !cache) {
-          lastTarget = target;
-          
-          const rect = dom.projectRect(target, app.container);
-          const style = window.getComputedStyle(target);
-          const padding = getPadding(app.state);
-
-          cache = {
-            width: rect.width + padding,
-            height: rect.height + padding,
-            radius: parseFloat(style.borderRadius) || 0,
-            x: rect.left + rect.width / 2,
-            y: rect.top + rect.height / 2
-          };
-        }
-
-        if (cache) {
-          // 1. Override Target (Physics) - Snap target to center of element
-          app.state.target.x = cache.x;
-          app.state.target.y = cache.y;
-
-          // 2. Set Shape (Visuals) - Visual plugins like Ring will read this
-          app.state.shape = {
-            width: cache.width,
-            height: cache.height,
-            borderRadius: cache.radius
-          };
-        }
-      } else {
-        // Reset
-        if (lastTarget) {
-          lastTarget = null;
-          cache = null;
-        }
-        app.state.shape = null;
-      }
-    }
-  }, options);
-};
+import type { ValueOrGetter, Supermouse } from "@supermousejs/core";
+import { definePlugin, normalize, dom } from "@supermousejs/utils";
+
+export interface StickOptions {
+  name?: string;
+  isEnabled?: boolean;
+  /** Extra padding around the element when calculating shape. Default 10. */
+  padding?: ValueOrGetter<number>;
+}
+
+export const Stick = (options: StickOptions = {}) => {
+  const getPadding = normalize(options.padding, 10);
+
+  let lastTarget: HTMLElement | null = null;
+  let cache: { width: number; height: number; radius: number; x: number; y: number } | null = null;
+
+  return definePlugin(
+    {
+      name: options.name || "stick",
+      // Logic plugin: must run before visuals to set the shape state
+      priority: -10,
+
+      install(app: Supermouse) {
+        app.registerHoverTarget("[data-supermouse-stick]");
+      },
+
+      update(app: Supermouse) {
+        // Check normalized interaction key (camelCase, no prefix)
+        const target = app.state.hoverTarget;
+        const isSticky =
+          app.state.interaction.stick === true || app.state.interaction.stick === "true";
+
+        if (target && isSticky) {
+          // Recalculate only if target changed or on first frame
+          if (target !== lastTarget || !cache) {
+            lastTarget = target;
+
+            const rect = dom.projectRect(target, app.container);
+            const style = window.getComputedStyle(target);
+            const padding = getPadding(app.state);
+
+            cache = {
+              width: rect.width + padding,
+              height: rect.height + padding,
+              radius: parseFloat(style.borderRadius) || 0,
+              x: rect.left + rect.width / 2,
+              y: rect.top + rect.height / 2
+            };
+          }
+
+          if (cache) {
+            // 1. Override Target (Physics) - Snap target to center of element
+            app.state.target.x = cache.x;
+            app.state.target.y = cache.y;
+
+            // 2. Set Shape (Visuals) - Visual plugins like Ring will read this
+            app.state.shape = {
+              width: cache.width,
+              height: cache.height,
+              borderRadius: cache.radius
+            };
+          }
+        } else {
+          // Reset
+          if (lastTarget) {
+            lastTarget = null;
+            cache = null;
+          }
+          app.state.shape = null;
+        }
+      }
+    },
+    options
+  );
+};

package/tsconfig.json

@@ -1,18 +1,4 @@
 {
-  "extends": "../../tsconfig.base.json",
-  "include": [
-    "src"
-  ],
-  "compilerOptions": {
-    "outDir": "dist",
-    "baseUrl": ".",
-    "paths": {
-      "@supermousejs/core": [
-        "../core/src/index.ts"
-      ],
-      "@supermousejs/utils": [
-        "../utils/src/index.ts"
-      ]
-    }
-  }
-}
+  "extends": "../../tsconfig.plugin.json",
+  "include": ["src"]
+}

package/vite.config.ts

@@ -1,22 +1,23 @@
-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: 'SupermouseStick',
-      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 })]
-});
+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: "SupermouseStick",
+      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 })]
+});