Skip to content

useDeviceMotion

Category
Export Size
758 B
Last Changed
3 hours ago

响应式的 DeviceMotionEvent。为开发者提供设备位置和方向变化速度的信息。

Demo

设备运动:
Not supported by your current browser.

用法

js
import { useDeviceMotion } from '@vueuse/core'

const {
  acceleration,
  accelerationIncludingGravity,
  rotationRate,
  interval,
} = useDeviceMotion()

注意:对于 iOS 设备,你需要使用 trigger 并将其与用户交互绑定。 在获得权限后,API 将自动运行

状态类型描述
accelerationobject一个对象,给出设备在 X、Y 和 Z 三个轴上的加速度。
accelerationIncludingGravityobject一个对象,给出设备在 X、Y 和 Z 三个轴上的加速度,包括重力影响。
rotationRateobject一个对象,给出设备在 alpha、beta 和 gamma 三个方向轴上的方向变化率。
intervalNumber一个数字,表示从设备获取数据的间隔时间,以毫秒为单位。
ensurePermissionsboolean指示平台是否需要权限才能使用该 API
permissionGrantedboolean指示用户是否已授予权限。默认为 false
triggerPromise<void>一个异步函数,用于请求用户权限。一旦获得权限,API 将自动运行

你可以在 MDN 上找到更多关于状态的信息

组件用法

vue
<template>
  <UseDeviceMotion v-slot="{ acceleration }">
    加速度: {{ acceleration }}
  </UseDeviceMotion>
</template>

Type Declarations

Show Type Declarations
typescript
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>

Source

SourceDemoDocs

Contributors

jorshen

Changelog

No recent changes

Released under the MIT License.