@supermousejs/vue 2.3.0 → 2.4.0

package/README.md

@@ -10,27 +10,44 @@ pnpm add @supermousejs/vue @supermousejs/core
 
 ## Usage
 
-**In `App.vue` (Root):**
+In `App.vue`/root file:
 
 ```vue
 <script setup>
 import { provideSupermouse } from "@supermousejs/vue";
 import { Dot } from "@supermousejs/dot";
 
-provideSupermouse({ smoothness: 0.15 }, [Dot({ size: 8 })]);
+const { instance, isEnabled } = provideSupermouse({ smoothness: 0.15 }, [Dot({ size: 8 })]);
 </script>
 ```
 
-**In Components:**
+And in your components:
 
 ```vue
 <script setup>
 import { useSupermouse } from "@supermousejs/vue";
 
-const mouse = useSupermouse(); // Returns Ref<Supermouse | null>
+const { instance, isEnabled } = useSupermouse();
+
+function toggleCursor() {
+  if (instance.value) {
+    if (isEnabled.value) instance.value.disable();
+    else instance.value.enable();
+  }
+}
 </script>
+
+<template>
+  <button @click="toggleCursor">{{ isEnabled ? "Disable" : "Enable" }} Cursor</button>
+</template>
 ```
 
+`provideSupermouse()` and `useSupermouse()` both return:
+
+- `instance`: A `Ref<SupermouseInstance | null>`.
+- `isEnabled`: A `Ref<boolean>` that stays in sync with `enable()` / `disable()`.
+
 ## Documentation
 
-Full documentation and interactive playground available at [supermouse](https://supermouse.js.org) or [check out the repo](https://github.com/Whitestar14/supermouse-js).
+Full documentation and interactive playground: [supermouse.js.org](https://supermouse.js.org)
+Repository: [github.com/Whitestar14/supermouse-js](https://github.com/Whitestar14/supermouse-js)

package/dist/index.mjs

@@ -1,24 +1,37 @@
-import { shallowRef as u, onMounted as i, onUnmounted as l, provide as p, inject as m } from "vue";
-import { Supermouse as a } from "@supermousejs/core";
-const r = /* @__PURE__ */ Symbol("Supermouse");
-function f(o = {}, s = []) {
-  const e = u(null);
-  return i(() => {
-    if (e.value) return;
-    const n = new a(o);
-    s.forEach((t) => n.use(t)), e.value = n;
-  }), l(() => {
-    e.value && (e.value.destroy(), e.value = null);
-  }), p(r, e), e;
+import { shallowRef as s, ref as t, onMounted as m, onUnmounted as d, provide as f, inject as v } from "vue";
+import { Supermouse as b } from "@supermousejs/core";
+import { Supermouse as h } from "@supermousejs/core";
+const l = /* @__PURE__ */ Symbol("Supermouse");
+function x(o = {}, a = []) {
+  const n = s(null), u = t(!0);
+  m(() => {
+    if (n.value) return;
+    const e = new b(o);
+    a.forEach((p) => e.use(p));
+    const i = e.enable.bind(e), c = e.disable.bind(e);
+    e.enable = () => {
+      i(), u.value = !0;
+    }, e.disable = () => {
+      c(), u.value = !1;
+    }, n.value = e;
+  }), d(() => {
+    n.value && (n.value.destroy(), n.value = null, u.value = !0);
+  });
+  const r = { instance: n, isEnabled: u };
+  return f(l, r), r;
 }
-function v() {
-  const o = m(r);
+function w() {
+  const o = v(l);
   return o || (console.warn(
     "[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."
-  ), u(null));
+  ), {
+    instance: s(null),
+    isEnabled: t(!0)
+  });
 }
 export {
-  r as SupermouseKey,
-  f as provideSupermouse,
-  v as useSupermouse
+  h as Supermouse,
+  l as SupermouseKey,
+  x as provideSupermouse,
+  w as useSupermouse
 };

package/dist/index.umd.js

@@ -1 +1 @@
-(function(e,u){typeof exports=="object"&&typeof module<"u"?u(exports,require("vue"),require("@supermousejs/core")):typeof define=="function"&&define.amd?define(["exports","vue","@supermousejs/core"],u):(e=typeof globalThis<"u"?globalThis:e||self,u(e.SupermouseVue={},e.Vue,e.SupermouseCore))})(this,(function(e,u,i){"use strict";const r=Symbol("Supermouse");function t(n={},d=[]){const o=u.shallowRef(null);return u.onMounted(()=>{if(o.value)return;const s=new i.Supermouse(n);d.forEach(m=>s.use(m)),o.value=s}),u.onUnmounted(()=>{o.value&&(o.value.destroy(),o.value=null)}),u.provide(r,o),o}function p(){const n=u.inject(r);return n||(console.warn("[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."),u.shallowRef(null))}e.SupermouseKey=r,e.provideSupermouse=t,e.useSupermouse=p,Object.defineProperty(e,Symbol.toStringTag,{value:"Module"})}));
+(function(u,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("vue"),require("@supermousejs/core")):typeof define=="function"&&define.amd?define(["exports","vue","@supermousejs/core"],e):(u=typeof globalThis<"u"?globalThis:u||self,e(u.SupermouseVue={},u.Vue,u.SupermouseCore))})(this,(function(u,e,i){"use strict";const t=Symbol("Supermouse");function d(r={},a=[]){const o=e.shallowRef(null),s=e.ref(!0);e.onMounted(()=>{if(o.value)return;const n=new i.Supermouse(r);a.forEach(m=>n.use(m));const c=n.enable.bind(n),f=n.disable.bind(n);n.enable=()=>{c(),s.value=!0},n.disable=()=>{f(),s.value=!1},o.value=n}),e.onUnmounted(()=>{o.value&&(o.value.destroy(),o.value=null,s.value=!0)});const l={instance:o,isEnabled:s};return e.provide(t,l),l}function p(){const r=e.inject(t);return r||(console.warn("[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."),{instance:e.shallowRef(null),isEnabled:e.ref(!0)})}Object.defineProperty(u,"Supermouse",{enumerable:!0,get:()=>i.Supermouse}),u.SupermouseKey=t,u.provideSupermouse=d,u.useSupermouse=p,Object.defineProperty(u,Symbol.toStringTag,{value:"Module"})}));

package/dist/vue/src/index.d.ts

@@ -1,18 +1,23 @@
 import { Ref, InjectionKey } from 'vue';
-import { Supermouse, SupermouseOptions, SupermousePlugin } from '../packages/core/src';
-export declare const SupermouseKey: InjectionKey<Ref<Supermouse | null>>;
+import { SupermouseOptions, SupermousePlugin, SupermouseInstance } from '../packages/core/src';
+export interface SupermouseContext {
+    instance: Ref<SupermouseInstance | null>;
+    isEnabled: Ref<boolean>;
+}
+export declare const SupermouseKey: InjectionKey<SupermouseContext>;
 /**
  * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
- * Use this in your root component (e.g., App.vue).
+ * Also exposes a reactive `isEnabled` ref that stays in sync with the instance's enable/disable state.
  *
  * @param options Core configuration options
  * @param plugins Array of plugins to install immediately
  */
-export declare function provideSupermouse(options?: SupermouseOptions, plugins?: SupermousePlugin[]): Ref<Supermouse | null>;
+export declare function provideSupermouse(options?: SupermouseOptions, plugins?: SupermousePlugin[]): SupermouseContext;
 /**
- * Injects the global Supermouse instance from a parent component.
- * @returns A Ref containing the Supermouse instance or null if not provided.
- * @warn Make sure to call provideSupermouse() in a parent component, otherwise this will return null.
+ * Injects the global Supermouse context (instance + reactive isEnabled).
+ * @returns The context, or a default empty context if not provided.
  */
-export declare function useSupermouse(): Ref<Supermouse | null>;
+export declare function useSupermouse(): SupermouseContext;
+export { Supermouse } from '../packages/core/src';
+export type { SupermouseInstance, SupermouseOptions, SupermousePlugin } from '../packages/core/src';
 //# sourceMappingURL=index.d.ts.map

package/dist/vue/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,KAAK,CAAC;AACb,OAAO,EAAE,UAAU,EAAE,KAAK,iBAAiB,EAAE,KAAK,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE/F,eAAO,MAAM,aAAa,EAAE,YAAY,CAAC,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAAwB,CAAC;AAExF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,iBAAsB,EAC/B,OAAO,GAAE,gBAAgB,EAAO,GAC/B,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAqBxB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,CAStD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,GAAG,EACR,KAAK,YAAY,EAClB,MAAM,KAAK,CAAC;AAEb,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAElG,MAAM,WAAW,iBAAiB;IAChC,QAAQ,EAAE,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IACzC,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,eAAO,MAAM,aAAa,EAAE,YAAY,CAAC,iBAAiB,CAAwB,CAAC;AAEnF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,GAAE,iBAAsB,EAC/B,OAAO,GAAE,gBAAgB,EAAO,GAC/B,iBAAiB,CAsCnB;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,iBAAiB,CAYjD;AAED,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC"}

package/package.json

@@ -1,19 +1,24 @@
 {
   "name": "@supermousejs/vue",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "main": "dist/index.umd.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
+  "description": "Vue 3 integration for Supermouse",
+  "files": [
+    "dist",
+    "README.md"
+  ],
   "author": "O.S David",
   "url": "https://github.com/Whitestar14/supermouse-js",
   "license": "MIT",
   "peerDependencies": {
     "vue": "^3.2.0",
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.4.0"
   },
   "devDependencies": {
     "vue": "^3.2.0",
-    "@supermousejs/core": "2.2.0"
+    "@supermousejs/core": "2.4.0"
   },
   "repository": {
     "type": "git",

package/CHANGELOG.md

@@ -1,80 +0,0 @@
-# @supermousejs/vue
-
-## 2.3.0
-
-### Patch Changes
-
-- Updated dependencies [f6f44b2]
-  - @supermousejs/core@2.2.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]
-  - @supermousejs/core@2.1.0
-
-## 2.1.1
-
-### Patch Changes
-
-- 67f771b: Add relevant npm metadata to package.json file
-- Updated dependencies [67f771b]
-  - @supermousejs/core@2.0.5
-
-## 2.1.0
-
-### Minor Changes
-
-- 0a1652d: fixed build architecture and updated plugin metadata
-
-## 2.0.4
-
-### Patch Changes
-
-- 993dc67: Updated supemousejs packages with proper author, license and url descriptors to repo
-- Updated dependencies [993dc67]
-  - @supermousejs/core@2.0.4
-
-## 2.0.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.3
-
-## 2.0.2
-
-### Patch Changes
-
-- ae219a0: Update READMEs with correct link to documentation
-- Updated dependencies [ae219a0]
-  - @supermousejs/core@2.0.2
-
-## 2.0.1
-
-### Patch Changes
-
-- Add minimal README.md files to packages
-- Updated dependencies
-  - @supermousejs/core@2.0.1
-
-## 2.0.0
-
-### Major Changes
-
-- Initial v2.0.0 release
-
-### Patch Changes
-
-- Updated dependencies
-  - @supermousejs/core@2.0.0

package/src/index.ts

@@ -1,61 +0,0 @@
-import {
-  onMounted,
-  onUnmounted,
-  provide,
-  inject,
-  shallowRef,
-  type Ref,
-  type InjectionKey
-} from "vue";
-import { Supermouse, type SupermouseOptions, type SupermousePlugin } from "@supermousejs/core";
-
-export const SupermouseKey: InjectionKey<Ref<Supermouse | null>> = Symbol("Supermouse");
-
-/**
- * Initializes a Supermouse instance, handles its lifecycle, and provides it to the component tree.
- * Use this in your root component (e.g., App.vue).
- *
- * @param options Core configuration options
- * @param plugins Array of plugins to install immediately
- */
-export function provideSupermouse(
-  options: SupermouseOptions = {},
-  plugins: SupermousePlugin[] = []
-): Ref<Supermouse | null> {
-  const instance = shallowRef<Supermouse | null>(null);
-
-  onMounted(() => {
-    if (instance.value) return;
-
-    const mouse = new Supermouse(options);
-    plugins.forEach((p) => mouse.use(p));
-    instance.value = mouse;
-  });
-
-  onUnmounted(() => {
-    if (instance.value) {
-      instance.value.destroy();
-      instance.value = null;
-    }
-  });
-
-  provide(SupermouseKey, instance);
-
-  return instance;
-}
-
-/**
- * Injects the global Supermouse instance from a parent component.
- * @returns A Ref containing the Supermouse instance or null if not provided.
- * @warn Make sure to call provideSupermouse() in a parent component, otherwise this will return null.
- */
-export function useSupermouse(): Ref<Supermouse | null> {
-  const instance = inject(SupermouseKey);
-  if (!instance) {
-    console.warn(
-      "[Supermouse] No instance provided. Ensure provideSupermouse() is called in a parent component."
-    );
-    return shallowRef(null);
-  }
-  return instance;
-}

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-  "extends": "../../tsconfig.framework.json",
-  "include": ["src"]
-}

package/vite.config.ts

@@ -1,34 +0,0 @@
-import { defineConfig } from "vite";
-import dts from "vite-plugin-dts";
-import path from "path";
-import { writeFileSync } from "fs";
-
-export default defineConfig({
-  build: {
-    lib: {
-      entry: path.resolve(__dirname, "src/index.ts"),
-      name: "SupermouseVue",
-      fileName: (format) => (format === "es" ? "index.mjs" : "index.umd.js")
-    },
-    rollupOptions: {
-      external: ["vue", "@supermousejs/core"],
-      output: {
-        globals: {
-          vue: "Vue",
-          "@supermousejs/core": "SupermouseCore"
-        }
-      }
-    }
-  },
-  plugins: [
-    dts({ rollupTypes: false }),
-    {
-      name: "dts-wrapper",
-      apply: "build",
-      closeBundle: async () => {
-        const wrapperContent = `export * from "./vue/src/index";\n`;
-        writeFileSync(path.resolve(__dirname, "dist/index.d.ts"), wrapperContent);
-      }
-    }
-  ]
-});