@supermousejs/text 2.2.0 → 2.3.1

package/README.md

@@ -1,6 +1,6 @@
 # @supermousejs/text
 
-Displays a contextual text label next to the cursor when hovering interactive elements.
+Injects contextual text bubbles near the cursor on interaction. Works like a tooltip.
 
 ## Installation
 
@@ -8,27 +8,26 @@ Displays a contextual text label next to the cursor when hovering interactive el
 pnpm add @supermousejs/text
 ```
 
-## Usage
+## Text
+
+Injects contextual text bubbles near the cursor on interaction. Works like a tooltip.
+
+### 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
-  })
-);
+app.use(Text({ duration: 200 }));
 ```
 
-**HTML:**
+### Options
 
-```html
-<button data-supermouse-text="Click Me">Hover Here</button>
-```
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| className | string | 'supermouse-text' | CSS class added to container. |
+| offset | [number, number] | [0, 24] | X/Y offset from cursor. |
+| duration | number | 200 | Fade transition time in ms. |
 
 ## Documentation
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SupermousePlugin } from '../../core/src';
+import { SupermousePlugin } from '../packages/core/src';
 
 declare const Text_2: (options?: TextOptions) => SupermousePlugin;
 export { Text_2 as Text }

package/package.json

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

package/CHANGELOG.md

@@ -1,82 +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/meta.json

@@ -1,32 +0,0 @@
-{
-  "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/src/index.ts

@@ -1,62 +0,0 @@
-import type { Supermouse } from "@supermousejs/core";
-import { definePlugin, dom, Layers, Easings } from "@supermousejs/utils";
-
-export interface TextOptions {
-  name?: string;
-  isEnabled?: boolean;
-  className?: string;
-  offset?: [number, number];
-  duration?: number;
-}
-
-export const Text = (options: TextOptions = {}) => {
-  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));
-        }
-
-        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");
-        }
-      }
-    },
-    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: "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 })]
-});