deviceorientation-js v1.0.0

DeviceOrientation

• event represented in methods is DeviceOrientationEvent obtained from deviceorientation listener, see more here. For supported browsers go here.

Example

import { getDeviceOrientation } from 'deviceorientation'

let previousOrientation = null
const handleOrientation = (event) => {
    const orientation = getDeviceOrientation(event)
    if (previousOrientation && previousOrientation !== orientation) {
        alert('orientation changed')
    }
    previousOrientation = orientation
}

window.addEventListener("deviceorientation", handleOrientation, true);

getDeviceOrientation(event, exactAngle = false)

• returns the device orientation as angle, if exactAngle is false (which is by default), it only returns 0, 90, 180 or 270 depending on which is more close to the current device angle. If it is set to true, it returns a number from 0 up to 360, which represents current angle (rounded).

isPortrait(event)

• if device is in portrait position, meaning getDeviceOrientation(event, false) === 0 || getDeviceOrientation(event, false) === 180

isLandscape(event)

• if device is in landscape (flipped to side) position, meaning getDeviceOrientation(event, false) === 90 || getDeviceOrientation(event, false) === 270

isPortraitDefault(event)

• if device is in standard portrait position, meaning getDeviceOrientation(event, false) === 0

isLandscapeRight(event)

• if device is in landscape (flipped to right side) position getDeviceOrientation(event, false) === 90

isPortraitReversed(event)

• if device is in reverse portrait position, meaning getDeviceOrientation(event, false) === 180

isLandscapeLeft(event)

• if device is in landscape (flipped to left side) position getDeviceOrientation(event, false) === 270

init(throwErrorIfNotSupported = false)

• sets deviceorientation listener for you, the last event will be cached, so you can call getDeviceOrientation without any parameter and the cached event will be used