@leonabcd123/modern-caps-lock 3.0.5 → 3.1.0

package/README.md

@@ -1,6 +1,6 @@
 # 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)
@@ -13,11 +13,9 @@ Modern Caps Lock provides an easy way to check whether Caps Lock is active or no
 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)
-5. [Support](#support)
-   1. [Supported Platforms](#supported-platforms)
-   2. [Unsupported Platforms](#unsupported-platforms)
-6. [Limitations](#limitations)
-7. [Credits](#credits)
+4. [Supported Platforms](#supported-platforms)
+5. [Limitations](#limitations)
+6. [Credits](#credits)
 
 ### Installation
 
@@ -31,7 +29,7 @@ npm install @leonabcd123/modern-caps-lock
 
 #### onCapsLockChange
 
-Runs the provided callback function whenever Caps Lock state is changed.
+Runs the provided callback function whenever the Caps Lock state changes.
 
 ##### Arguments
 
@@ -51,7 +49,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
@@ -77,23 +75,18 @@ if (isCapsLockOn()) {
 }
 ```
 
-### Support
-
-##### Supported Platforms
+### Supported Platforms
 
 - Windows
 - Mac
 - Linux
 - iPad
-
-##### Unsupported Platforms
-
-- Platforms using [GBoard](https://en.wikipedia.org/wiki/Gboard)
+- Android
 
 ### 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
@@ -101,7 +94,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,16 +32,16 @@ document.addEventListener("keyup", (event) => {
         }
         else {
             const currentCapsState = getCapsLockModifierState(event);
-            if (isSendingCapsLockStateOniPad || currentCapsState) {
+            if (isSendingCapsLockState || currentCapsState) {
                 capsState = currentCapsState;
-                isSendingCapsLockStateOniPad = true;
+                isSendingCapsLockState = true;
             }
         }
     }
     else if (os === "Windows") {
         capsState = getCapsLockModifierState(event);
     }
-    else if (event.key !== "CapsLock") {
+    else if (event.key !== "CapsLock" && event.key !== "Unidentified") {
         capsState = getCapsLockModifierState(event);
     }
     callCallbackIfNeeded();

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|Android/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.5",
+  "version": "3.1.0",
   "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"
   },