@ouroboros/browser 0.5.2 → 0.5.4

package/README.md

@@ -1,5 +1,4 @@
 # @ouroboros/browser
-
 [![npm version](https://img.shields.io/npm/v/@ouroboros/browser.svg)](https://www.npmjs.com/package/@ouroboros/browser) ![MIT License](https://img.shields.io/npm/l/@ouroboros/browser.svg)
 
 A library of classes to manage functionality in browsers.
@@ -24,7 +23,7 @@ or
 import { clipboard } from '@ouroboros/browser';
 ```
 
-copy()
+`clipboard.copy()`
 
 ## cookies
 
@@ -40,7 +39,23 @@ or
 import { cookies } from '@ouroboros/browser';
 ```
 
-get(), remove(), set()
+`get()`, `remove()`, `set()`
+
+## devices
+
+Import Devices into your code
+
+```javascript
+import devices, { hasPointer, isMobile } from '@ouroboros/browser/devices';
+```
+
+or
+
+```javascript
+import { devices } from '@ouroboros/browser';
+```
+
+`devices.hasPointer()`
 
 ## hash
 
@@ -56,7 +71,7 @@ or
 import { hash } from '@ouroboros/browser';
 ```
 
-get(), set(), subscribe(), unsubscribe()
+`hash.get()`, `hash.set()`, `hash.subscribe()`, `hash.unsubscribe()`
 
 ## network
 
@@ -72,7 +87,7 @@ or
 import { network } from '@ouroboros/browser';
 ```
 
-default (Subscribe)
+default (`Subscribe`)
 
 ## pageVisibility
 
@@ -88,7 +103,7 @@ or
 import { pageVisibility } from '@ouroboros/browser';
 ```
 
-default (Subscribe)
+default (`Subscribe`)
 
 ## safeLocalStorage
 
@@ -104,7 +119,7 @@ or
 import { safeLocalStorage } from '@ouroboros/browser';
 ```
 
-bool(), json(), string()
+`safeLocalStorage.bool()`, `safeLocalStorage.json()`, `safeLocalStorage.string()`
 
 ## size
 
@@ -120,4 +135,4 @@ or
 import { size } from '@ouroboros/browser';
 ```
 
-size (Subscribe), compare(), greaterThan(), lessThan()
+default (`Subscribe`), `size.compare()`, `size.greaterThan()`, `size.lessThan()`

package/devices.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Device
+ *
+ * Functions for getting device information
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2025-04-16
+ */
+/**
+ * Has Pointer
+ *
+ * Returns true only if the device has some sort of pointer device like a mouse.
+ *
+ * @name hasPointer
+ * @access public
+ * @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

@@ -0,0 +1,48 @@
+/**
+ * Device
+ *
+ * Functions for getting device information
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2025-04-16
+ */
+/**
+ * Has Pointer
+ *
+ * Returns true only if the device has some sort of pointer device like a mouse.
+ *
+ * @name hasPointer
+ * @access public
+ * @returns bool
+ */
+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, isMobile };
+export default devices;

package/index.d.ts

@@ -1,5 +1,6 @@
 export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
+export { default as devices } from './devices';
 export { default as hash } from './hash';
 export { default as network } from './network';
 export { default as pageVisibility } from './pageVisibility';

package/index.js

@@ -1,5 +1,6 @@
 export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
+export { default as devices } from './devices';
 export { default as hash } from './hash';
 export { default as network } from './network';
 export { default as pageVisibility } from './pageVisibility';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ouroboros/browser",
-	"version": "0.5.2",
+	"version": "0.5.4",
 	"description": "Package to handle common browser functionality.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -37,7 +37,7 @@
 	},
 	"dependencies": {
 		"@ouroboros/clone": "^1.1.0",
-		"@ouroboros/subscribe": "^1.3.1",
-		"@ouroboros/tools": "^0.6.1"
+		"@ouroboros/subscribe": "^1.3.2",
+		"@ouroboros/tools": "^0.7.1"
 	}
 }

package/src/devices.ts

@@ -0,0 +1,55 @@
+/**
+ * Device
+ *
+ * Functions for getting device information
+ *
+ * @author Chris Nasr <chris@ouroboroscoding.com>
+ * @copyright Ouroboros Coding Inc.
+ * @created 2025-04-16
+ */
+
+/**
+ * Has Pointer
+ *
+ * Returns true only if the device has some sort of pointer device like a mouse.
+ *
+ * @name hasPointer
+ * @access public
+ * @returns bool
+ */
+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, isMobile }
+export default devices;

package/src/index.ts

@@ -1,5 +1,6 @@
 export { default as clipboard } from './clipboard';
 export { default as cookies } from './cookies';
+export { default as devices } from './devices';
 export { default as hash } from './hash';
 export { default as network } from './network';
 export { default as pageVisibility } from './pageVisibility';