useDeviceOrientation

Category

Sensors

Export Size

308 B

Last Changed

5 days ago

Reactive DeviceOrientationEvent

Demo

Usage

import { useDeviceOrientation } from '@reause/core'

const { isAbsolute, alpha, beta, gamma } = useDeviceOrientation()

State	Type	Description
isAbsolute	boolean | null	Whether the device orientation is absolute (relative to the Earth's coordinate system) or relative to the device.
alpha	number | null	The rotation of the device around the z axis (0–360 degrees).
beta	number | null	The rotation of the device around the x axis (−180–180 degrees).
gamma	number | null	The rotation of the device around the y axis (−90–90 degrees).

You can find more information about the state on the MDN.

Type Declarations

export interface UseDeviceOrientationOptions extends ConfigurableWindow {
}

export interface UseDeviceOrientationReturn {
    isSupported: boolean;
    isAbsolute: boolean | null;
    alpha: number | null;
    beta: number | null;
    gamma: number | null;
}

export function useDeviceOrientation(options?: UseDeviceOrientationOptions): UseDeviceOrientationReturn

Source

Source · Demo · VueUse

Contributors

Changelog

v0.1.0 on

48bd8 - fix(core): resolve useDeviceOrientation audit findings (#540)

e16c8 - feat(core): add useDeviceOrientation (#108)