detect-device-orientation v0.2.1

detect-device-orientation

Overview

Detect device orientation.

Notes

• DeviceOrientationEvent is available only in secure contexts (HTTPS), in some or all supporting browsers.

Installation

You can install this library using npm:

npm install detect-device-orientation

Usage

import {
  DetectDeviceOrientation,
  Orientation,
} from "detect-device-orientation";

const detectDeviceOrientation = new DetectDeviceOrientation();

detectDeviceOrientation.init((orientation: Orientation) => {
  console.log(`absolute: ${orientation.absolute}`);
  // [Output] absolute: true

  console.log(`alpha: ${orientation.absolute}`);
  // [Output] alpha: 0

  console.log(`beta: ${orientation.beta}`);
  // [Output] beta: 0

  console.log(`gamma: ${orientation.gamma}`);
  // [Output] gamma: 0

  console.log(`webkitCompassHeading: ${orientation.webkitCompassHeading}`);
  // [Output] webkitCompassHeading: 0

  console.log(`webkitCompassAccuracy: ${orientation.webkitCompassAccuracy}`);
  // [Output] webkitCompassHeading: 0
});

In iOS Safari, requestPermission should be called through a user event, such as clicking a button.

var btn = document.createElement("BUTTON");
var text = document.createTextNode(
  "Request Device Orientation Event Permission",
);
btn.appendChild(text);
document.body.appendChild(btn);
btn.addEventListener("click", function () {
  detectDeviceOrientation.requestDeviceOrientationPermission;
});

Output

Link

• DeviceOrientationEvent

License

This project is licensed under the MIT License - see the LICENSE file for details.