@supermousejs/icon 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @supermousejs/icon
 
+## 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

package/README.md

@@ -0,0 +1,29 @@
+
+# @supermousejs/icon
+
+Renders a static SVG icon at the cursor position. Useful for custom pointers.
+
+## Installation
+
+```bash
+pnpm add @supermousejs/icon
+```
+
+## 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'
+}));
+```
+
+## Documentation
+
+Full documentation and interactive playground available at [supermouse](https://supermouse.vercel.app) or [check out the repo](https://github.com/Whitestar14/supermouse-js).

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@supermousejs/icon",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
   "dependencies": {
-    "@supermousejs/core": "2.0.0",
-    "@supermousejs/utils": "2.0.0"
+    "@supermousejs/core": "2.0.2",
+    "@supermousejs/utils": "2.0.2"
   },
   "devDependencies": {},
   "peerDependencies": {},

package/src/index.ts

@@ -1,52 +1,52 @@
-import type { ValueOrGetter } 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;
-      el.style.zIndex = Layers.CURSOR;
-      el.style.display = 'flex';
-      el.style.alignItems = 'center';
-      el.style.justifyContent = 'center';
-      el.innerHTML = options.svg;
-      return el;
-    },
-
-    styles: {
-      color: 'color'
-    },
-
-    update: (app, el) => {
-      const size = getSize(app.state);
-      dom.setStyle(el, 'width', `${size}px`);
-      dom.setStyle(el, 'height', `${size}px`);
-      dom.setStyle(el, 'opacity', String(getOpacity(app.state)));
-      dom.setStyle(el, 'color', getColor(app.state));
-
-      const { x, y } = app.state.smooth;
-      dom.setTransform(el, x + offX, y + offY, 0);
-    }
-  }, options);
+import type { ValueOrGetter } 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;
+      el.style.zIndex = Layers.CURSOR;
+      el.style.display = 'flex';
+      el.style.alignItems = 'center';
+      el.style.justifyContent = 'center';
+      el.innerHTML = options.svg;
+      return el;
+    },
+
+    styles: {
+      color: 'color'
+    },
+
+    update: (app, el) => {
+      const size = getSize(app.state);
+      dom.setStyle(el, 'width', `${size}px`);
+      dom.setStyle(el, 'height', `${size}px`);
+      dom.setStyle(el, 'opacity', String(getOpacity(app.state)));
+      dom.setStyle(el, 'color', getColor(app.state));
+
+      const { x, y } = app.state.smooth;
+      dom.setTransform(el, x + offX, y + offY, 0);
+    }
+  }, options);
 };

package/tsconfig.json

@@ -1,18 +1,18 @@
-{
-  "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.base.json",
+  "include": [
+    "src"
+  ],
+  "compilerOptions": {
+    "outDir": "dist",
+    "baseUrl": ".",
+    "paths": {
+      "@supermousejs/core": [
+        "../core/src/index.ts"
+      ],
+      "@supermousejs/utils": [
+        "../utils/src/index.ts"
+      ]
+    }
+  }
 }

package/vite.config.ts

@@ -1,26 +1,26 @@
-import { defineConfig } from 'vite';
-import dts from 'vite-plugin-dts';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-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 })]
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+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 })]
 });