4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
81 lines
3.4 KiB
Markdown
81 lines
3.4 KiB
Markdown
---
|
|
category: Sensors
|
|
---
|
|
|
|
# useDeviceMotion
|
|
|
|
Reactive [DeviceMotionEvent](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent). Provide web developers with information about the speed of changes for the device's position and orientation.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { useDeviceMotion } from '@vueuse/core'
|
|
|
|
const {
|
|
acceleration,
|
|
accelerationIncludingGravity,
|
|
rotationRate,
|
|
interval,
|
|
} = useDeviceMotion()
|
|
```
|
|
|
|
> Note: For iOS, you need to use `trigger` and bind it with user interaction.
|
|
> After permission granted, the API will run automatically
|
|
|
|
| State | Type | Description |
|
|
| ---------------------------- | --------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
| acceleration | `object` | An object giving the acceleration of the device on the three axis X, Y and Z. |
|
|
| accelerationIncludingGravity | `object` | An object giving the acceleration of the device on the three axis X, Y and Z with the effect of gravity. |
|
|
| rotationRate | `object` | An object giving the rate of change of the device's orientation on the three orientation axis alpha, beta and gamma. |
|
|
| interval | `Number` | A number representing the interval of time, in milliseconds, at which data is obtained from the device.. |
|
|
| ensurePermissions | `boolean` | Indicates whether the platform requires permission to use the API |
|
|
| permissionGranted | `boolean` | Indicates whether the user has granted permission. The default is always false |
|
|
| trigger | `Promise<void>` | An async function to request user permission. The API runs automatically once permission is granted |
|
|
|
|
You can find [more information about the state on the MDN](https://developer.mozilla.org/en-US/docs/Web/API/DeviceMotionEvent#instance_properties).
|
|
|
|
## Component Usage
|
|
|
|
```vue
|
|
<template>
|
|
<UseDeviceMotion v-slot="{ acceleration }">
|
|
Acceleration: {{ acceleration }}
|
|
</UseDeviceMotion>
|
|
</template>
|
|
```
|
|
|
|
## Type Declarations
|
|
|
|
```ts
|
|
export interface UseDeviceMotionOptions
|
|
extends ConfigurableWindow, ConfigurableEventFilter {
|
|
/**
|
|
* Request for permissions immediately if it's not granted,
|
|
* otherwise label and deviceIds could be empty
|
|
*
|
|
* @default false
|
|
*/
|
|
requestPermissions?: boolean
|
|
}
|
|
/** @deprecated use {@link UseDeviceMotionOptions} instead */
|
|
export type DeviceMotionOptions = UseDeviceMotionOptions
|
|
export interface UseDeviceMotionReturn extends Supportable {
|
|
acceleration: Ref<DeviceMotionEventAcceleration | null>
|
|
accelerationIncludingGravity: Ref<DeviceMotionEventAcceleration | null>
|
|
rotationRate: Ref<DeviceMotionEventRotationRate | null>
|
|
interval: ShallowRef<number>
|
|
requirePermissions: ComputedRef<boolean>
|
|
ensurePermissions: () => Promise<void>
|
|
permissionGranted: ShallowRef<boolean>
|
|
}
|
|
/**
|
|
* Reactive DeviceMotionEvent.
|
|
*
|
|
* @see https://vueuse.org/useDeviceMotion
|
|
* @param options
|
|
*/
|
|
export declare function useDeviceMotion(
|
|
options?: UseDeviceMotionOptions,
|
|
): UseDeviceMotionReturn
|
|
```
|