@leonabcd123/modern-caps-lock 3.0.4 → 3.0.6

package/README.md

@@ -1,6 +1,23 @@
 # Modern Caps Lock
 
-Modern Caps Lock provides an easy way to check whether Caps Lock is active or not, and it allows you to run your code whenever Caps Lock state changes.
+Modern Caps Lock provides an easy way to check whether Caps Lock is active, and it allows you to run your code whenever the Caps Lock state changes.
+
+1. [Installation](#installation)
+2. [API](#api)
+   1. [`onCapsLockChange`](#oncapslockchange)
+      1. [Arguments](#arguments)
+      2. [Return value](#return-value)
+   2. [`isCapsLockOn`](#iscapslockon)
+      1. [Arguments](#arguments-1)
+      2. [Return value](#return-value-1)
+3. [Examples](#examples)
+   1. [Print Caps Lock state after every change](#print-caps-lock-state-after-every-change)
+   2. [Get current Caps Lock state](#get-current-caps-lock-state)
+4. [Support](#support)
+   1. [Supported Platforms](#supported-platforms)
+   2. [Unsupported Platforms](#unsupported-platforms)
+5. [Limitations](#limitations)
+6. [Credits](#credits)
 
 ### Installation
 
@@ -12,9 +29,9 @@ npm install @leonabcd123/modern-caps-lock
 
 ### API
 
-#### onCapsLockChange()
+#### onCapsLockChange
 
-Runs the provided callback function whenever Caps Lock state is changed.
+Runs the provided callback function whenever the Caps Lock state changes.
 
 ##### Arguments
 
@@ -24,7 +41,7 @@ Runs the provided callback function whenever Caps Lock state is changed.
 
 `void`.
 
-#### isCapsLockOn()
+#### isCapsLockOn
 
 Returns the current Caps Lock state.
 
@@ -34,7 +51,7 @@ None.
 
 ##### Return value
 
-`capsState: boolean`: a boolean representing the current Caps Lock state. If `true`, Caps Lock is on; if `false`, Caps Lock is off.
+`capsState: boolean`: a boolean indicating whether Caps Lock is on. If `true`, Caps Lock is on; if `false`, Caps Lock is off.
 
 
 ### Examples
@@ -62,21 +79,21 @@ if (isCapsLockOn()) {
 
 ### Support
 
-##### Supported Platforms:
+##### Supported Platforms
 
 - Windows
 - Mac
 - Linux
 - iPad
 
-##### Unsupported Platforms:
+##### Unsupported Platforms
 
 - Platforms using [GBoard](https://en.wikipedia.org/wiki/Gboard)
 
 ### Limitations
 
 Because of browser limitations, we can only detect the Caps Lock state after a KeyboardEvent
-or a MouseEvent. We currently detect updates to the Caps Lock state when the following events are fired:
+or MouseEvent occurs. We currently detect updates to the Caps Lock state when the following events are fired:
 
 - keydown
 - keyup
@@ -84,7 +101,7 @@ or a MouseEvent. We currently detect updates to the Caps Lock state when the fol
 - mousemove
 - wheel
 
-Before any of these events are fired, Caps Lock state is off.
+Until one of these events is fired, the Caps Lock state defaults to `false`.
 
 ### Credits
 

package/lib/index.js

@@ -1,26 +1,11 @@
-function isPlatform(osName) {
-    var _a, _b;
-    return osName.test((_b = (_a = navigator.userAgentData) === null || _a === void 0 ? void 0 : _a.platform) !== null && _b !== void 0 ? _b : (navigator.oscpu || navigator.userAgent || navigator.platform));
-}
-function getCurrentOs() {
-    if (isPlatform(/Mac/i)) {
-        return "Mac";
-    }
-    if (isPlatform(/Linux/i)) {
-        return "Linux";
-    }
-    if (isPlatform(/Win/i)) {
-        return "Windows";
-    }
-    return "Unknown";
-}
+import { getCurrentOs } from "./os-detection";
 let previousCapsState = false;
 let capsState = false;
 const os = getCurrentOs();
 let onCapsChangeCallback;
 const mouseEventsToUpdateOn = ["mousedown", "mousemove", "wheel"];
 const isiPad = os === "Mac" && navigator.maxTouchPoints > 1;
-let isSendingCapsLockStateOniPad = !isiPad;
+let isSendingCapsLockState = !isiPad;
 function callCallbackIfNeeded() {
     const callCallback = previousCapsState !== capsState;
     previousCapsState = capsState;
@@ -34,11 +19,9 @@ function getCapsLockModifierState(event) {
 }
 mouseEventsToUpdateOn.forEach((eventType) => {
     document.addEventListener(eventType, (event) => {
-        if (event instanceof MouseEvent) {
-            if (!isiPad) {
-                capsState = getCapsLockModifierState(event);
-                callCallbackIfNeeded();
-            }
+        if (!isiPad) {
+            capsState = getCapsLockModifierState(event);
+            callCallbackIfNeeded();
         }
     });
 });
@@ -49,9 +32,9 @@ document.addEventListener("keyup", (event) => {
         }
         else {
             const currentCapsState = getCapsLockModifierState(event);
-            isSendingCapsLockStateOniPad || (isSendingCapsLockStateOniPad = currentCapsState);
-            if (isSendingCapsLockStateOniPad) {
+            if (isSendingCapsLockState || currentCapsState) {
                 capsState = currentCapsState;
+                isSendingCapsLockState = true;
             }
         }
     }
@@ -82,4 +65,3 @@ export function isCapsLockOn() {
 export function onCapsLockChange(callback) {
     onCapsChangeCallback = callback;
 }
-//# sourceMappingURL=index.js.map

package/lib/os-detection.d.ts

@@ -0,0 +1 @@
+export declare function getCurrentOs(): "Mac" | "Linux" | "Windows" | "Unknown";

package/lib/os-detection.js

@@ -0,0 +1,16 @@
+function isPlatform(osName) {
+    var _a, _b, _c;
+    return osName.test((_b = (_a = navigator.userAgentData) === null || _a === void 0 ? void 0 : _a.platform) !== null && _b !== void 0 ? _b : ((_c = navigator.oscpu) !== null && _c !== void 0 ? _c : "") + navigator.userAgent + navigator.platform);
+}
+export function getCurrentOs() {
+    if (isPlatform(/Mac/i)) {
+        return "Mac";
+    }
+    if (isPlatform(/Linux/i)) {
+        return "Linux";
+    }
+    if (isPlatform(/Win/i)) {
+        return "Windows";
+    }
+    return "Unknown";
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leonabcd123/modern-caps-lock",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "A package that allows you to check whether caps lock is active or not",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -29,7 +29,7 @@
   "contributors": [
     "fehmer"
   ],
-  "license": "GPL-3.0-only",
+  "license": "GPL-3.0-or-later",
   "bugs": {
     "url": "https://github.com/Leonabcd123/modern-caps-lock/issues"
   },

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,SAAS,UAAU,CAAC,MAAc;;IAIhC,OAAO,MAAM,CAAC,IAAI,CAAC,MAAA,MAAA,SAAS,CAAC,aAAa,0CAAE,QAAQ,mCAAI,CAAC,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;AAC1H,CAAC;AAOD,SAAS,YAAY;IACnB,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAC9B,IAAI,SAAS,GAAG,KAAK,CAAC;AACtB,MAAM,EAAE,GAAG,YAAY,EAAE,CAAC;AAE1B,IAAI,oBAA0C,CAAC;AAE/C,MAAM,qBAAqB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAClE,MAAM,MAAM,GAAG,EAAE,KAAK,KAAK,IAAI,SAAS,CAAC,cAAc,GAAG,CAAC,CAAC;AAI5D,IAAI,4BAA4B,GAAG,CAAC,MAAM,CAAC;AAK3C,SAAS,oBAAoB;IAC3B,MAAM,YAAY,GAAG,iBAAiB,KAAK,SAAS,CAAC;IACrD,iBAAiB,GAAG,SAAS,CAAC;IAC9B,IAAI,YAAY,EAAE,CAAC;QAEjB,oBAAoB,aAApB,oBAAoB,uBAApB,oBAAoB,CAAG,SAAS,CAAC,CAAC;IACpC,CAAC;AACH,CAAC;AAQD,SAAS,wBAAwB,CAAC,KAAiC;;IAIjE,OAAO,MAAA,MAAA,KAAK,CAAC,gBAAgB,sDAAG,UAAU,CAAC,mCAAI,SAAS,CAAC;AAC3D,CAAC;AAED,qBAAqB,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;IAC1C,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;QAC7C,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAEhC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;gBAC5C,oBAAoB,EAAE,CAAC;YACzB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;IAC3C,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;QAEjB,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC7B,SAAS,GAAG,KAAK,CAAC;QACpB,CAAC;aAAM,CAAC;YAMN,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;YACzD,4BAA4B,KAA5B,4BAA4B,GAAK,gBAAgB,EAAC;YAClD,IAAI,4BAA4B,EAAE,CAAC;gBAEjC,SAAS,GAAG,gBAAgB,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;SAAM,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QAE5B,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;SAAM,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;QAEpC,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IACD,oBAAoB,EAAE,CAAC;AACzB,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAAK,EAAE,EAAE;IAC7C,IAAI,EAAE,KAAK,KAAK,EAAE,CAAC;QAEjB,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC7B,SAAS,GAAG,IAAI,CAAC;YACjB,oBAAoB,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;SAAM,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QAI1B,IAAI,KAAK,CAAC,GAAG,KAAK,UAAU,EAAE,CAAC;YAC7B,SAAS,GAAG,CAAC,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAOH,MAAM,UAAU,YAAY;IAC1B,OAAO,SAAS,CAAC;AACnB,CAAC;AAOD,MAAM,UAAU,gBAAgB,CAAC,QAA8B;IAC7D,oBAAoB,GAAG,QAAQ,CAAC;AAClC,CAAC"}