useGeolocation

类别

Sensors

导出体积

553 B

上次更改

7 months ago

提供响应式的 Geolocation API。如果用户愿意，它允许用户向 Web 应用程序提供其位置。出于隐私原因，用户需要获得报告位置信息的权限。

示例

源码 playground (beta)

{
  "coords": {
    "accuracy": 0,
    "latitude": null,
    "longitude": null,
    "altitude": null,
    "altitudeAccuracy": null,
    "heading": null,
    "speed": null
  },
  "locatedAt": null,
  "error": null
}

使用方法

import { useGeolocation
 } from '@vueuse/core'

const { coords
, locatedAt
, error
, resume
, pause
 } = useGeolocation
()

状态	类型	描述
coords	`Coordinates`	获取的位置信息，如纬度和经度
locatedAt	`Date`	最后一次地理定位的时间
error	`string`	如果地理定位 API 失败，则显示错误消息。
resume	`function`	控制函数，用于恢复更新地理定位。
pause	`function`	控制函数，用于暂停更新地理定位。

配置

useGeolocation 函数可以接受 PositionOptions 对象作为可选参数。

组件使用

vue

<template>
  <UseGeolocation v-slot="{ coords: { latitude
, longitude
 } }">
    纬度：{{ latitude
 }} 经度：{{ longitude
 }}
  </UseGeolocation>
</template>

类型声明

显示类型声明

export interface UseGeolocationOptions
  extends Partial
<PositionOptions>,
    ConfigurableNavigator {
  immediate
?: boolean
}
/**
 * 响应式 Geolocation API.
 *
 * @see https://vueuse.org/useGeolocation
 * @param options
 */
export declare function useGeolocation
(options
?: UseGeolocationOptions): {
  isSupported
: ComputedRef
<boolean>
  coords
: Ref
<
    {
      readonly accuracy
: number
      readonly altitude
: number | null
      readonly altitudeAccuracy
: number | null
      readonly heading
: number | null
      readonly latitude
: number
      readonly longitude
: number
      readonly speed
: number | null
    },
    | Omit
<GeolocationCoordinates, "toJSON">
    | {
        readonly accuracy
: number
        readonly altitude
: number | null
        readonly altitudeAccuracy
: number | null
        readonly heading
: number | null
        readonly latitude
: number
        readonly longitude
: number
        readonly speed
: number | null
      }
  >
  locatedAt
: ShallowRef
<number | null, number | null>
  error
: ShallowRef
<
    GeolocationPositionError | null,
    GeolocationPositionError | null
  >
  resume
: () => void
  pause
: () => void
}
export type UseGeolocationReturn
 = ReturnType
<typeof useGeolocation
>