@supermousejs/icon 2.3.0 → 2.3.1

package/README.md

@@ -1,6 +1,6 @@
 # @supermousejs/icon
 
-Renders a static SVG icon at the cursor position. Useful for custom pointers.
+Renders a static SVG icon at the cursor position.
 
 ## Installation
 
@@ -8,23 +8,29 @@ Renders a static SVG icon at the cursor position. Useful for custom pointers.
 pnpm add @supermousejs/icon
 ```
 
-## Usage
+## Icon
+
+Renders a static SVG icon at the cursor position.
+
+### Usage
 
 ```ts
 import { Supermouse } from "@supermousejs/core";
 import { Icon } from "@supermousejs/icon";
-
 const app = new Supermouse();
-
-app.use(
-  Icon({
-    svg: "<svg>...</svg>", // Your SVG string
-    size: 24,
-    color: "black"
-  })
-);
+app.use(Icon({ svg: '<svg>...</svg>', size: 24 }));
 ```
 
+### Options
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| svg | string | undefined | SVG content string. (Required) |
+| size | number | 24 | Size of the icon container. |
+| color | string | 'black' | CSS color (currentColor). |
+| opacity | number | 1 | Opacity level (0-1). |
+| offset | [number, number] | [0, 0] | Fixed [x, y] offset from cursor center. |
+
 ## 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/icon",
-  "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,95 +0,0 @@
-# @supermousejs/icon
-
-## 2.3.0
-
-### Patch Changes
-
-- Updated dependencies [f6f44b2]
-  - @supermousejs/core@2.2.0
-  - @supermousejs/utils@2.3.0
-
-## 2.2.0
-
-### Minor Changes
-
-- 9fe1a7b: - Implemented idiomatic approach to using supermouse/utils
-  - Rewrote `applyStyles`, `setTransform` and `setStyles` to share a global cache registry
-
-### 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,45 +0,0 @@
-{
-  "id": "icon",
-  "name": "Icon",
-  "package": "@supermousejs/icon",
-  "description": "Renders a static SVG icon at the cursor position.",
-  "code": "app.use(Icon({ svg: '<svg>...</svg>', size: 24 }));",
-  "icon": "context",
-  "options": [
-    {
-      "name": "svg",
-      "type": "string",
-      "default": "undefined",
-      "description": "SVG content string. (Required)",
-      "reactive": false
-    },
-    {
-      "name": "size",
-      "type": "number",
-      "default": "24",
-      "description": "Size of the icon container.",
-      "reactive": true
-    },
-    {
-      "name": "color",
-      "type": "string",
-      "default": "'black'",
-      "description": "CSS color (currentColor).",
-      "reactive": true
-    },
-    {
-      "name": "opacity",
-      "type": "number",
-      "default": "1",
-      "description": "Opacity level (0-1).",
-      "reactive": true
-    },
-    {
-      "name": "offset",
-      "type": "[number, number]",
-      "default": "[0, 0]",
-      "description": "Fixed [x, y] offset from cursor center.",
-      "reactive": false
-    }
-  ]
-}

package/src/index.ts

@@ -1,63 +0,0 @@
-import type { ValueOrGetter, Supermouse } from "@supermousejs/core";
-import { definePlugin, normalize, dom, Layers } from "@supermousejs/utils";
-
-export interface IconOptions {
-  name?: string;
-  isEnabled?: boolean;
-  /** SVG Content String */
-  svg: string;
-  /** Size in pixels (default 24) */
-  size?: ValueOrGetter<number>;
-  /** CSS Color (default black) */
-  color?: ValueOrGetter<string>;
-  opacity?: ValueOrGetter<number>;
-  /** Offset [x, y] from cursor center */
-  offset?: [number, number];
-}
-
-export const Icon = (options: IconOptions) => {
-  const getSize = normalize(options.size, 24);
-  const getOpacity = normalize(options.opacity, 1);
-  const getColor = normalize(options.color, "black");
-  const [offX, offY] = options.offset || [0, 0];
-
-  return definePlugin<HTMLDivElement, IconOptions>(
-    {
-      name: options.name || "icon",
-
-      create: () => {
-        const el = dom.createActor("div") as HTMLDivElement;
-
-        dom.applyStyles(el, {
-          zIndex: String(Layers.CURSOR),
-          display: "flex",
-          alignItems: "center",
-          justifyContent: "center"
-        });
-
-        el.innerHTML = options.svg;
-        return el;
-      },
-
-      styles: {
-        color: "color"
-      },
-
-      update: (app: Supermouse, el: HTMLDivElement) => {
-        const state = app.state;
-        const size = getSize(state);
-
-        dom.applyStyles(el, {
-          width: `${size}px`,
-          height: `${size}px`,
-          opacity: String(getOpacity(state)),
-          color: getColor(state)
-        });
-
-        const { x, y } = state.smooth;
-        dom.setTransform(el, x + offX, y + offY, 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: "SupermouseIcon",
-      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 })]
-});