@supermousejs/text 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,59 +1,82 @@
-# @supermousejs/text
-
-## 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/text
+
+## 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,35 @@
-
-# @supermousejs/text
-
-Displays a contextual text label next to the cursor when hovering interactive elements.
-
-## Installation
-
-```bash
-pnpm add @supermousejs/text
-```
-
-## Usage
-
-```ts
-import { Supermouse } from '@supermousejs/core';
-import { Text } from '@supermousejs/text';
-
-const app = new Supermouse();
-
-app.use(Text({
-  offset: [20, 20], // X, Y offset from cursor
-  duration: 200     // Fade duration
-}));
-```
-
-**HTML:**
-```html
-<button data-supermouse-text="Click Me">Hover Here</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/text
+
+Displays a contextual text label next to the cursor when hovering interactive elements.
+
+## Installation
+
+```bash
+pnpm add @supermousejs/text
+```
+
+## Usage
+
+```ts
+import { Supermouse } from "@supermousejs/core";
+import { Text } from "@supermousejs/text";
+
+const app = new Supermouse();
+
+app.use(
+  Text({
+    offset: [20, 20], // X, Y offset from cursor
+    duration: 200 // Fade duration
+  })
+);
+```
+
+**HTML:**
+
+```html
+<button data-supermouse-text="Click Me">Hover Here</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,4 +1,4 @@
-import { SupermousePlugin } from '../../core/src/index.ts';
+import { SupermousePlugin } from '../../core/src';
 
 declare const Text_2: (options?: TextOptions) => SupermousePlugin;
 export { Text_2 as Text }

package/dist/index.mjs

@@ -2,29 +2,32 @@ import { definePlugin as f, dom as e, Easings as p, Layers as u } from "@supermo
 const y = (s = {}) => {
   const r = s.className || "supermouse-text", [c, i] = s.offset || [0, 24], l = s.duration || 200;
   let a;
-  return f({
-    name: "text",
-    selector: "[data-supermouse-text]",
-    create: () => {
-      const t = e.createActor("div");
-      return e.applyStyles(t, {
-        zIndex: u.OVERLAY,
-        opacity: "0",
-        transition: `opacity ${l}ms ${p.SMOOTH}`,
-        whiteSpace: "nowrap",
-        pointerEvents: "none"
-      }), t.classList.add(...r.split(" ").filter(Boolean)), a = document.createElement("span"), t.appendChild(a), e.setTransform(t, -100, -100), t;
+  return f(
+    {
+      name: "text",
+      selector: "[data-supermouse-text]",
+      create: () => {
+        const t = e.createActor("div");
+        return e.applyStyles(t, {
+          zIndex: u.OVERLAY,
+          opacity: "0",
+          transition: `opacity ${l}ms ${p.SMOOTH}`,
+          whiteSpace: "nowrap",
+          pointerEvents: "none"
+        }), t.classList.add(...r.split(" ").filter(Boolean)), a = document.createElement("span"), t.appendChild(a), e.setTransform(t, -100, -100), t;
+      },
+      update: (t, o) => {
+        const n = t.state.interaction.text;
+        if (t.state.isHover && n) {
+          a.innerText = n, e.setStyle(o, "opacity", "1");
+          const { x: d, y: m } = t.state.smooth;
+          e.setTransform(o, d + c, m + i);
+        } else
+          e.setStyle(o, "opacity", "0");
+      }
     },
-    update: (t, o) => {
-      const n = t.state.interaction.text;
-      if (t.state.isHover && n) {
-        a.innerText = n, e.setStyle(o, "opacity", "1");
-        const { x: d, y: m } = t.state.smooth;
-        e.setTransform(o, d + c, m + i);
-      } else
-        e.setStyle(o, "opacity", "0");
-    }
-  }, s);
+    s
+  );
 };
 export {
   y as Text

package/meta.json

@@ -1,15 +1,32 @@
-
-{
-  "id": "text",
-  "name": "Text",
-  "package": "@supermousejs/text",
-  "description": "Injects contextual text bubbles near the cursor on interaction.",
-  "code": "app.use(Text({ font: 'Mono' }));",
-  "recipeId": "text-cursor",
-  "icon": "text",
-  "options": [
-    { "name": "className", "type": "string", "default": "'supermouse-text'", "description": "CSS class added to container.", "reactive": false },
-    { "name": "offset", "type": "[number, number]", "default": "[0, 24]", "description": "X/Y offset from cursor.", "reactive": false },
-    { "name": "duration", "type": "number", "default": "200", "description": "Fade transition time in ms.", "reactive": false }
-  ]
-}
+{
+  "id": "text",
+  "name": "Text",
+  "package": "@supermousejs/text",
+  "description": "Injects contextual text bubbles near the cursor on interaction.",
+  "code": "app.use(Text({ font: 'Mono' }));",
+  "recipeId": "text-cursor",
+  "icon": "text",
+  "options": [
+    {
+      "name": "className",
+      "type": "string",
+      "default": "'supermouse-text'",
+      "description": "CSS class added to container.",
+      "reactive": false
+    },
+    {
+      "name": "offset",
+      "type": "[number, number]",
+      "default": "[0, 24]",
+      "description": "X/Y offset from cursor.",
+      "reactive": false
+    },
+    {
+      "name": "duration",
+      "type": "number",
+      "default": "200",
+      "description": "Fade transition time in ms.",
+      "reactive": false
+    }
+  ]
+}

package/package.json

@@ -1,21 +1,30 @@
 {
   "name": "@supermousejs/text",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "author": "O.S David",
   "url": "https://github.com/Whitestar14/supermouse-js",
   "license": "MIT",
   "dependencies": {
-    "@supermousejs/utils": "2.1.0"
+    "@supermousejs/utils": "2.2.0"
   },
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "peerDependencies": {
-    "@supermousejs/core": "2.0.4"
+    "@supermousejs/core": "2.1.0"
   },
   "devDependencies": {
-    "@supermousejs/core": "2.0.4"
+    "@supermousejs/core": "2.1.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Whitestar14/supermouse-js.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/Whitestar14/supermouse-js/issues"
+  },
+  "homepage": "https://github.com/Whitestar14/supermouse-js/tree/main/packages/text#readme",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",

package/src/index.ts

@@ -1,4 +1,5 @@
-import { definePlugin, dom, Layers, Easings } from '@supermousejs/utils';
+import type { Supermouse } from "@supermousejs/core";
+import { definePlugin, dom, Layers, Easings } from "@supermousejs/utils";
 
 export interface TextOptions {
   name?: string;
@@ -9,52 +10,53 @@ export interface TextOptions {
 }
 
 export const Text = (options: TextOptions = {}) => {
-  const className = options.className || 'supermouse-text';
+  const className = options.className || "supermouse-text";
   const [offX, offY] = options.offset || [0, 24];
   const duration = options.duration || 200;
-  
+
   let textNode: HTMLSpanElement;
 
-  return definePlugin<HTMLDivElement, TextOptions>({
-    name: 'text',
-    selector: '[data-supermouse-text]',
-
-    create: () => {
-      const el = dom.createActor('div') as HTMLDivElement;
-      
-      dom.applyStyles(el, {
-        zIndex: Layers.OVERLAY,
-        opacity: '0',
-        transition: `opacity ${duration}ms ${Easings.SMOOTH}`,
-        whiteSpace: 'nowrap',
-        pointerEvents: 'none'
-      });
-
-      if (className) {
-        el.classList.add(...className.split(' ').filter(Boolean));
+  return definePlugin<HTMLDivElement, TextOptions>(
+    {
+      name: "text",
+      selector: "[data-supermouse-text]",
+
+      create: () => {
+        const el = dom.createActor("div") as HTMLDivElement;
+
+        dom.applyStyles(el, {
+          zIndex: Layers.OVERLAY,
+          opacity: "0",
+          transition: `opacity ${duration}ms ${Easings.SMOOTH}`,
+          whiteSpace: "nowrap",
+          pointerEvents: "none"
+        });
+
+        if (className) {
+          el.classList.add(...className.split(" ").filter(Boolean));
+        }
+
+        textNode = document.createElement("span");
+        el.appendChild(textNode);
+
+        dom.setTransform(el, -100, -100);
+        return el;
+      },
+
+      update: (app: Supermouse, el: HTMLDivElement) => {
+        const text = app.state.interaction.text;
+
+        if (app.state.isHover && text) {
+          textNode.innerText = text;
+          dom.setStyle(el, "opacity", "1");
+
+          const { x, y } = app.state.smooth;
+          dom.setTransform(el, x + offX, y + offY);
+        } else {
+          dom.setStyle(el, "opacity", "0");
+        }
       }
-      
-      textNode = document.createElement('span');
-      el.appendChild(textNode);
-
-      dom.setTransform(el, -100, -100);
-      return el;
     },
-
-    update: (app, el) => {
-      // Use pre-parsed interaction data instead of querying DOM
-      const text = app.state.interaction.text;
-
-      if (app.state.isHover && text) {
-        textNode.innerText = text;
-        dom.setStyle(el, 'opacity', '1');
-        
-        // Dynamic position based on pointer
-        const { x, y } = app.state.smooth;
-        dom.setTransform(el, x + offX, y + offY);
-      } else {
-        dom.setStyle(el, 'opacity', '0');
-      }
-    }
-  }, options);
+    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: 'SupermouseText',
-      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: "SupermouseText",
+      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 })]
+});