f5792c40be
Pulled ALL skills from 15 source repositories: - anthropics/skills: 16 (docs, design, MCP, testing) - obra/superpowers: 14 (TDD, debugging, agents, planning) - coreyhaines31/marketingskills: 25 (marketing, CRO, SEO, growth) - better-auth/skills: 5 (auth patterns) - vercel-labs/agent-skills: 5 (React, design, Vercel) - antfu/skills: 16 (Vue, Vite, Vitest, pnpm, Turborepo) - Plus 13 individual skills from various repos Mosaic Stack is not limited to coding — the Orchestrator and subagents serve coding, business, design, marketing, writing, logistics, analysis, and more. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
88 lines
3.4 KiB
Markdown
88 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 DeviceMotionOptions
|
|
extends ConfigurableWindow,
|
|
ConfigurableEventFilter {
|
|
/**
|
|
* Request for permissions immediately if it's not granted,
|
|
* otherwise label and deviceIds could be empty
|
|
*
|
|
* @default false
|
|
*/
|
|
requestPermissions?: boolean
|
|
}
|
|
/**
|
|
* Reactive DeviceMotionEvent.
|
|
*
|
|
* @see https://vueuse.org/useDeviceMotion
|
|
* @param options
|
|
*/
|
|
export declare function useDeviceMotion(options?: DeviceMotionOptions): {
|
|
acceleration: Ref<
|
|
DeviceMotionEventAcceleration | null,
|
|
DeviceMotionEventAcceleration | null
|
|
>
|
|
accelerationIncludingGravity: Ref<
|
|
DeviceMotionEventAcceleration | null,
|
|
DeviceMotionEventAcceleration | null
|
|
>
|
|
rotationRate: Ref<
|
|
DeviceMotionEventRotationRate | null,
|
|
DeviceMotionEventRotationRate | null
|
|
>
|
|
interval: ShallowRef<number, number>
|
|
isSupported: ComputedRef<boolean>
|
|
requirePermissions: ComputedRef<boolean>
|
|
ensurePermissions: () => Promise<void>
|
|
permissionGranted: ShallowRef<boolean, boolean>
|
|
}
|
|
export type UseDeviceMotionReturn = ReturnType<typeof useDeviceMotion>
|
|
```
|