@ouroboros/browser 0.5.3 → 0.5.4

package/README.md

@@ -46,7 +46,7 @@ import { cookies } from '@ouroboros/browser';
 Import Devices into your code
 
 ```javascript
-import devices, { hasPointer } from '@ouroboros/browser/devices';
+import devices, { hasPointer, isMobile } from '@ouroboros/browser/devices';
 ```
 
 or

package/devices.d.ts

@@ -17,7 +17,19 @@
  * @returns bool
  */
 export declare function hasPointer(): boolean;
+/**
+ * Is Mobile
+ *
+ * Returns true only if the device appears to be a mobile device, but does not
+ * gaurantee anything.
+ *
+ * @name isMobile
+ * @access public
+ * @returns bool
+ */
+export declare function isMobile(): boolean;
 declare const devices: {
     hasPointer: typeof hasPointer;
+    isMobile: typeof isMobile;
 };
 export default devices;

package/devices.js

@@ -19,6 +19,30 @@
 export function hasPointer() {
     return window.matchMedia("(any-hover: hover)").matches;
 }
+/**
+ * Is Mobile
+ *
+ * Returns true only if the device appears to be a mobile device, but does not
+ * gaurantee anything.
+ *
+ * @name isMobile
+ * @access public
+ * @returns bool
+ */
+export function isMobile() {
+    // Mobile regex
+    const reMobile = /iPhone|Android.*Mobile|Mobile.*Android|KaiOS/i;
+    // If any of the following fail, we are probably on desktop
+    if (!reMobile.test(navigator.userAgent)
+        || !('ontouchstart' in window)
+        || !('orientation' in window)
+        || window.innerWidth >= 768) {
+        // Not a mobile device
+        return false;
+    }
+    // Probably a mobile device
+    return true;
+}
 // Default export
-const devices = { hasPointer };
+const devices = { hasPointer, isMobile };
 export default devices;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ouroboros/browser",
-	"version": "0.5.3",
+	"version": "0.5.4",
 	"description": "Package to handle common browser functionality.",
 	"main": "index.js",
 	"types": "index.d.ts",

package/src/devices.ts

@@ -21,6 +21,35 @@ export function hasPointer(): boolean {
 	return window.matchMedia("(any-hover: hover)").matches
 }
 
+/**
+ * Is Mobile
+ *
+ * Returns true only if the device appears to be a mobile device, but does not
+ * gaurantee anything.
+ *
+ * @name isMobile
+ * @access public
+ * @returns bool
+ */
+export function isMobile(): boolean {
+
+	// Mobile regex
+	const reMobile = /iPhone|Android.*Mobile|Mobile.*Android|KaiOS/i;
+
+	// If any of the following fail, we are probably on desktop
+	if(!reMobile.test(navigator.userAgent)
+		|| !('ontouchstart' in window)
+		|| !('orientation' in window)
+		|| window.innerWidth >= 768) {
+
+		// Not a mobile device
+		return false;
+	}
+
+	// Probably a mobile device
+	return true;
+}
+
 // Default export
-const devices = { hasPointer }
+const devices = { hasPointer, isMobile }
 export default devices;