useDeviceOrientation
Reactive DeviceOrientationEvent. Provide web developers with information from the physical orientation of the device running the web page.
Usage
import { useDeviceOrientation } from '@vueuse/core'
const {
isAbsolute,
alpha,
beta,
gamma,
} = useDeviceOrientation()| State | Type | Description |
|---|---|---|
| isAbsolute | boolean |
A boolean that indicates whether or not the device is providing orientation data absolutely. |
| alpha | number |
A number representing the motion of the device around the z axis, express in degrees with values ranging from 0 to 360. |
| beta | number |
A number representing the motion of the device around the x axis, express in degrees with values ranging from -180 to 180. |
| gamma | number |
A number representing the motion of the device around the y axis, express in degrees with values ranging from -90 to 90. |
You can find more information about the state on the MDN.
Component Usage
<template>
<UseDeviceOrientation v-slot="{ alpha, beta, gamma }">
Alpha: {{ alpha }}
Beta: {{ beta }}
Gamma: {{ gamma }}
</UseDeviceOrientation>
</template>Type Declarations
export interface UseDeviceOrientationOptions extends ConfigurableWindow {}
export interface UseDeviceOrientationReturn extends Supportable {
isAbsolute: ShallowRef<boolean, boolean>
alpha: Ref<number | null, number | null>
beta: Ref<number | null, number | null>
gamma: Ref<number | null, number | null>
}
/**
* Reactive DeviceOrientationEvent.
*
* @see https://vueuse.org/useDeviceOrientation
* @param options
*
* @__NO_SIDE_EFFECTS__
*/
export declare function useDeviceOrientation(
options?: UseDeviceOrientationOptions,
): UseDeviceOrientationReturn