react-device-sensors 0.0.1

package/dist/index.cjs

@@ -0,0 +1,68 @@
+'use strict';
+
+var react = require('react');
+
+// Created Thu Jan 22 01:00:51 AM IST 2026
+/**
+ *  Acceleration axes follow the Device coordinate frame (Image https://developer.mozilla.org/en-US/docs/Web/API/Device_orientation_events/Orientation_and_motion_data_explained/axes.png)
+ *      > The x axis is in the plane of the screen and is positive toward the right and negative toward the left.
+ *      > The y axis is in the plane of the screen and is positive toward the top and negative toward the bottom.
+ *      > The z axis is perpendicular to the screen or keyboard, and is positive extending outward from the screen.
+ *  Acceleration measured in m/s^2
+ *
+ * References
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent
+ *
+ * Unavailable properties are set to null
+ **/
+function useDeviceSensors() {
+    const [data, setData] = react.useState({
+        rotationRateAlpha: 0,
+        rotationRateBeta: 0,
+        rotationRateGamma: 0,
+        accelerationX: 0,
+        accelerationY: 0,
+        accelerationZ: 0,
+        orientationAbsolute: false,
+        orientationAlpha: 0,
+        orientationBeta: 0,
+        orientationGamma: 0,
+    });
+    react.useEffect(() => {
+        function handleDeviceOrientation(e) {
+            setData((d) => ({
+                ...d,
+                orientationAbsolute: e.absolute,
+                orientationAlpha: e.alpha,
+                orientationBeta: e.beta,
+                orientationGamma: e.gamma,
+            }));
+        }
+        function handleDeviceMotion(e) {
+            if (e.rotationRate === null || e.rotationRate === undefined) {
+                return;
+            }
+            setData((d) => ({
+                ...d,
+                rotationRateAlpha: e.rotationRate?.alpha ?? null,
+                rotationRateBeta: e.rotationRate?.beta ?? null,
+                rotationRateGamma: e.rotationRate?.gamma ?? null,
+                accelerationX: e.acceleration?.x ?? null,
+                accelerationY: e.acceleration?.y ?? null,
+                accelerationZ: e.acceleration?.z ?? null,
+            }));
+        }
+        window.addEventListener("devicemotion", handleDeviceMotion);
+        window.addEventListener("deviceorientation", handleDeviceOrientation);
+        console.log("PS: Ignore the above warnings");
+        return () => {
+            window.removeEventListener("devicemotion", handleDeviceMotion);
+            window.removeEventListener("deviceorientation", handleDeviceOrientation);
+        };
+    }, []);
+    return data;
+}
+
+module.exports = useDeviceSensors;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/useDeviceSensors.ts"],"sourcesContent":[null],"names":["useState","useEffect"],"mappings":";;;;AAAA;AA2DA;;;;;;;;;;;;AAYI;AACU,SAAU,gBAAgB,GAAA;AACpC,IAAA,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAGA,cAAQ,CAAmB;AAC/C,QAAA,iBAAiB,EAAE,CAAC;AACpB,QAAA,gBAAgB,EAAE,CAAC;AACnB,QAAA,iBAAiB,EAAE,CAAC;AAEpB,QAAA,aAAa,EAAE,CAAC;AAChB,QAAA,aAAa,EAAE,CAAC;AAChB,QAAA,aAAa,EAAE,CAAC;AAEhB,QAAA,mBAAmB,EAAE,KAAK;AAC1B,QAAA,gBAAgB,EAAE,CAAC;AACnB,QAAA,eAAe,EAAE,CAAC;AAClB,QAAA,gBAAgB,EAAE,CAAC;AACtB,KAAA,CAAC;IACFC,eAAS,CAAC,MAAK;QACX,SAAS,uBAAuB,CAAC,CAAyB,EAAA;AACtD,YAAA,OAAO,CAAC,CAAC,CAAC,MAAM;AACZ,gBAAA,GAAG,CAAC;gBACJ,mBAAmB,EAAE,CAAC,CAAC,QAAQ;gBAC/B,gBAAgB,EAAE,CAAC,CAAC,KAAK;gBACzB,eAAe,EAAE,CAAC,CAAC,IAAI;gBACvB,gBAAgB,EAAE,CAAC,CAAC,KAAK;AAC5B,aAAA,CAAC,CAAC;QACP;QACA,SAAS,kBAAkB,CAAC,CAAoB,EAAA;AAC5C,YAAA,IAAI,CAAC,CAAC,YAAY,KAAK,IAAI,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS,EAAE;gBACzD;YACJ;AACA,YAAA,OAAO,CAAC,CAAC,CAAC,MAAM;AACZ,gBAAA,GAAG,CAAC;AACJ,gBAAA,iBAAiB,EAAE,CAAC,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI;AAChD,gBAAA,gBAAgB,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,IAAI,IAAI;AAC9C,gBAAA,iBAAiB,EAAE,CAAC,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI;AAEhD,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AACxC,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AACxC,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AAC3C,aAAA,CAAC,CAAC;QACP;AAEA,QAAA,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAC3D,QAAA,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;AACrE,QAAA,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC;AAE5C,QAAA,OAAO,MAAK;AACR,YAAA,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAC9D,YAAA,MAAM,CAAC,mBAAmB,CACtB,mBAAmB,EACnB,uBAAuB,CAC1B;AACL,QAAA,CAAC;IACL,CAAC,EAAE,EAAE,CAAC;AAEN,IAAA,OAAO,IAAI;AACf;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./useDeviceSensors";
+export * from "./useDeviceSensors";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,cAAc,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,66 @@
+import { useState, useEffect } from 'react';
+
+// Created Thu Jan 22 01:00:51 AM IST 2026
+/**
+ *  Acceleration axes follow the Device coordinate frame (Image https://developer.mozilla.org/en-US/docs/Web/API/Device_orientation_events/Orientation_and_motion_data_explained/axes.png)
+ *      > The x axis is in the plane of the screen and is positive toward the right and negative toward the left.
+ *      > The y axis is in the plane of the screen and is positive toward the top and negative toward the bottom.
+ *      > The z axis is perpendicular to the screen or keyboard, and is positive extending outward from the screen.
+ *  Acceleration measured in m/s^2
+ *
+ * References
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent
+ *
+ * Unavailable properties are set to null
+ **/
+function useDeviceSensors() {
+    const [data, setData] = useState({
+        rotationRateAlpha: 0,
+        rotationRateBeta: 0,
+        rotationRateGamma: 0,
+        accelerationX: 0,
+        accelerationY: 0,
+        accelerationZ: 0,
+        orientationAbsolute: false,
+        orientationAlpha: 0,
+        orientationBeta: 0,
+        orientationGamma: 0,
+    });
+    useEffect(() => {
+        function handleDeviceOrientation(e) {
+            setData((d) => ({
+                ...d,
+                orientationAbsolute: e.absolute,
+                orientationAlpha: e.alpha,
+                orientationBeta: e.beta,
+                orientationGamma: e.gamma,
+            }));
+        }
+        function handleDeviceMotion(e) {
+            if (e.rotationRate === null || e.rotationRate === undefined) {
+                return;
+            }
+            setData((d) => ({
+                ...d,
+                rotationRateAlpha: e.rotationRate?.alpha ?? null,
+                rotationRateBeta: e.rotationRate?.beta ?? null,
+                rotationRateGamma: e.rotationRate?.gamma ?? null,
+                accelerationX: e.acceleration?.x ?? null,
+                accelerationY: e.acceleration?.y ?? null,
+                accelerationZ: e.acceleration?.z ?? null,
+            }));
+        }
+        window.addEventListener("devicemotion", handleDeviceMotion);
+        window.addEventListener("deviceorientation", handleDeviceOrientation);
+        console.log("PS: Ignore the above warnings");
+        return () => {
+            window.removeEventListener("devicemotion", handleDeviceMotion);
+            window.removeEventListener("deviceorientation", handleDeviceOrientation);
+        };
+    }, []);
+    return data;
+}
+
+export { useDeviceSensors as default };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/useDeviceSensors.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;AA2DA;;;;;;;;;;;;AAYI;AACU,SAAU,gBAAgB,GAAA;AACpC,IAAA,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAmB;AAC/C,QAAA,iBAAiB,EAAE,CAAC;AACpB,QAAA,gBAAgB,EAAE,CAAC;AACnB,QAAA,iBAAiB,EAAE,CAAC;AAEpB,QAAA,aAAa,EAAE,CAAC;AAChB,QAAA,aAAa,EAAE,CAAC;AAChB,QAAA,aAAa,EAAE,CAAC;AAEhB,QAAA,mBAAmB,EAAE,KAAK;AAC1B,QAAA,gBAAgB,EAAE,CAAC;AACnB,QAAA,eAAe,EAAE,CAAC;AAClB,QAAA,gBAAgB,EAAE,CAAC;AACtB,KAAA,CAAC;IACF,SAAS,CAAC,MAAK;QACX,SAAS,uBAAuB,CAAC,CAAyB,EAAA;AACtD,YAAA,OAAO,CAAC,CAAC,CAAC,MAAM;AACZ,gBAAA,GAAG,CAAC;gBACJ,mBAAmB,EAAE,CAAC,CAAC,QAAQ;gBAC/B,gBAAgB,EAAE,CAAC,CAAC,KAAK;gBACzB,eAAe,EAAE,CAAC,CAAC,IAAI;gBACvB,gBAAgB,EAAE,CAAC,CAAC,KAAK;AAC5B,aAAA,CAAC,CAAC;QACP;QACA,SAAS,kBAAkB,CAAC,CAAoB,EAAA;AAC5C,YAAA,IAAI,CAAC,CAAC,YAAY,KAAK,IAAI,IAAI,CAAC,CAAC,YAAY,KAAK,SAAS,EAAE;gBACzD;YACJ;AACA,YAAA,OAAO,CAAC,CAAC,CAAC,MAAM;AACZ,gBAAA,GAAG,CAAC;AACJ,gBAAA,iBAAiB,EAAE,CAAC,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI;AAChD,gBAAA,gBAAgB,EAAE,CAAC,CAAC,YAAY,EAAE,IAAI,IAAI,IAAI;AAC9C,gBAAA,iBAAiB,EAAE,CAAC,CAAC,YAAY,EAAE,KAAK,IAAI,IAAI;AAEhD,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AACxC,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AACxC,gBAAA,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,IAAI,IAAI;AAC3C,aAAA,CAAC,CAAC;QACP;AAEA,QAAA,MAAM,CAAC,gBAAgB,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAC3D,QAAA,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,uBAAuB,CAAC;AACrE,QAAA,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC;AAE5C,QAAA,OAAO,MAAK;AACR,YAAA,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,kBAAkB,CAAC;AAC9D,YAAA,MAAM,CAAC,mBAAmB,CACtB,mBAAmB,EACnB,uBAAuB,CAC1B;AACL,QAAA,CAAC;IACL,CAAC,EAAE,EAAE,CAAC;AAEN,IAAA,OAAO,IAAI;AACf;;;;"}

package/dist/useDeviceSensors.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Object containing metrics like device's rotation rate, acceleration and orientation.
+ */
+export type DeviceSensorData = {
+    /**
+     * The rate at which the device is rotating about its X axis; that is, front to back.
+     */
+    rotationRateAlpha: number | null;
+    /**
+     * The rate at which the device is rotating about its Y axis; that is, side to side.
+     */
+    rotationRateBeta: number | null;
+    /**
+     * The rate at which the device is rotating about its Z axis; that is, being twisted about a line perpendicular to the screen.
+     */
+    rotationRateGamma: number | null;
+    /**
+     * Represents the acceleration along the x axis
+     */
+    accelerationX: number | null;
+    /**
+     * Represents the acceleration along the y axis
+     */
+    accelerationY: number | null;
+    /**
+     * Represents the acceleration along the z axis
+     */
+    accelerationZ: number | null;
+    /**
+     * A boolean that indicates whether or not the device is providing orientation data absolutely.
+     */
+    orientationAbsolute: boolean | null;
+    /**
+     *  A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 (inclusive) to 360 (exclusive).
+     */
+    orientationAlpha: number | null;
+    /**
+     *  A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 (inclusive) to 180 (exclusive). This represents a front to back motion of the device.
+     */
+    orientationBeta: number | null;
+    /**
+     *  A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 (inclusive) to 90 (exclusive). This represents a left to right motion of the device.
+     */
+    orientationGamma: number | null;
+};
+/**
+ *  Acceleration axes follow the Device coordinate frame (Image https://developer.mozilla.org/en-US/docs/Web/API/Device_orientation_events/Orientation_and_motion_data_explained/axes.png)
+ *      > The x axis is in the plane of the screen and is positive toward the right and negative toward the left.
+ *      > The y axis is in the plane of the screen and is positive toward the top and negative toward the bottom.
+ *      > The z axis is perpendicular to the screen or keyboard, and is positive extending outward from the screen.
+ *  Acceleration measured in m/s^2
+ *
+ * References
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent/
+ *      > https://developer.mozilla.org/en-US/docs/Web/API/DeviceOrientationEvent
+ *
+ * Unavailable properties are set to null
+ **/
+export default function useDeviceSensors(): DeviceSensorData;
+//# sourceMappingURL=useDeviceSensors.d.ts.map

package/dist/useDeviceSensors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useDeviceSensors.d.ts","sourceRoot":"","sources":["../src/useDeviceSensors.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,mBAAmB,EAAE,OAAO,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;IAYI;AACJ,MAAM,CAAC,OAAO,UAAU,gBAAgB,qBAuDvC"}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "type": "module",
+  "name": "react-device-sensors",
+  "sideEffects": false,
+  "version": "0.0.1",
+  "description": "Simple react hook for accessing device's Sensor data",
+  "main": "index.js",
+  "keywords": [],
+  "author": "",
+  "license": "GPL-3.0-only",
+  "peerDependencies": {
+    "react": "^19.2.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/react": "^19.2.9",
+    "rollup": "^4.55.3",
+    "tslib": "^2.8.1"
+  },
+  "scripts": {
+    "build": "pnpx rollup -c"
+  }
+}