@leonabcd123/modern-caps-lock 3.0.3 → 3.0.5

package/README.md

@@ -2,6 +2,23 @@
 
 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.
 
+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)
+5. [Support](#support)
+   1. [Supported Platforms](#supported-platforms)
+   2. [Unsupported Platforms](#unsupported-platforms)
+6. [Limitations](#limitations)
+7. [Credits](#credits)
+
 ### Installation
 
 Example installation with npm:
@@ -12,7 +29,7 @@ npm install @leonabcd123/modern-caps-lock
 
 ### API
 
-#### onCapsLockChange()
+#### onCapsLockChange
 
 Runs the provided callback function whenever Caps Lock state is changed.
 
@@ -24,7 +41,7 @@ Runs the provided callback function whenever Caps Lock state is changed.
 
 `void`.
 
-#### isCapsLockOn()
+#### isCapsLockOn
 
 Returns the current Caps Lock state.
 
@@ -60,6 +77,32 @@ if (isCapsLockOn()) {
 }
 ```
 
+### Support
+
+##### Supported Platforms
+
+- Windows
+- Mac
+- Linux
+- iPad
+
+##### 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:
+
+- keydown
+- keyup
+- mousedown
+- mousemove
+- wheel
+
+Before any of these events are fired, Caps Lock state is off.
+
 ### Credits
 
 Created by [Leon](https://github.com/Leonabcd123) and [fehmer](https://github.com/fehmer).

package/lib/index.d.ts

@@ -1,2 +1,4 @@
+type OnCapsChangeCallback = (capsState: boolean) => void;
 export declare function isCapsLockOn(): boolean;
-export declare function onCapsLockChange(callback: (capsState: boolean) => void): void;
+export declare function onCapsLockChange(callback: OnCapsChangeCallback): void;
+export {};

package/lib/index.js

@@ -1,15 +1,15 @@
 function isPlatform(osName) {
-    var _a;
-    return (((_a = navigator.userAgentData) !== null && _a !== void 0 ? _a : navigator).platform).toLowerCase().startsWith(osName) || new RegExp(osName, "i").test(navigator.userAgent);
+    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")) {
+    if (isPlatform(/Mac/i)) {
         return "Mac";
     }
-    if (isPlatform("linux")) {
+    if (isPlatform(/Linux/i)) {
         return "Linux";
     }
-    if (isPlatform("win")) {
+    if (isPlatform(/Win/i)) {
         return "Windows";
     }
     return "Unknown";
@@ -19,6 +19,8 @@ let capsState = false;
 const os = getCurrentOs();
 let onCapsChangeCallback;
 const mouseEventsToUpdateOn = ["mousedown", "mousemove", "wheel"];
+const isiPad = os === "Mac" && navigator.maxTouchPoints > 1;
+let isSendingCapsLockStateOniPad = !isiPad;
 function callCallbackIfNeeded() {
     const callCallback = previousCapsState !== capsState;
     previousCapsState = capsState;
@@ -33,8 +35,10 @@ function getCapsLockModifierState(event) {
 mouseEventsToUpdateOn.forEach((eventType) => {
     document.addEventListener(eventType, (event) => {
         if (event instanceof MouseEvent) {
-            capsState = getCapsLockModifierState(event);
-            callCallbackIfNeeded();
+            if (!isiPad) {
+                capsState = getCapsLockModifierState(event);
+                callCallbackIfNeeded();
+            }
         }
     });
 });
@@ -44,8 +48,10 @@ document.addEventListener("keyup", (event) => {
             capsState = false;
         }
         else {
-            if (navigator.maxTouchPoints <= 1) {
-                capsState = getCapsLockModifierState(event);
+            const currentCapsState = getCapsLockModifierState(event);
+            if (isSendingCapsLockStateOniPad || currentCapsState) {
+                capsState = currentCapsState;
+                isSendingCapsLockStateOniPad = true;
             }
         }
     }
@@ -76,4 +82,3 @@ export function isCapsLockOn() {
 export function onCapsLockChange(callback) {
     onCapsChangeCallback = callback;
 }
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@leonabcd123/modern-caps-lock",
-  "version": "3.0.3",
-  "description": "A package that allows you to know whether caps lock is active or not",
+  "version": "3.0.5",
+  "description": "A package that allows you to check whether caps lock is active or not",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "type": "module",

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;;IAGhC,OAAO,CAAC,CAAC,MAAA,SAAS,CAAC,aAAa,mCAAI,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AACjJ,CAAC;AAOD,SAAS,YAAY;IACnB,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACxB,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,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;AAC1B,IAAI,oBAAkD,CAAC;AAEvD,MAAM,qBAAqB,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;AAKlE,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,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;YAC5C,oBAAoB,EAAE,CAAC;QACzB,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;YAIN,IAAI,SAAS,CAAC,cAAc,IAAI,CAAC,EAAE,CAAC;gBAElC,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;YAC9C,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,QAAsC;IACrE,oBAAoB,GAAG,QAAQ,CAAC;AAClC,CAAC"}