useGeolocation

Demo

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

Usage

import { useGeolocation
 } from '@vueuse/core'

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

State	Type	Description
coords	`Coordinates`	information about the position retrieved like the latitude and longitude
locatedAt	`Date`	The time of the last geolocation call
error	`string`	An error message in case geolocation API fails.
resume	`function`	Control function to resume updating geolocation
pause	`function`	Control function to pause updating geolocation

Config

useGeolocation function takes PositionOptions object as an optional parameter.

Component Usage

This function also provides a renderless component version via the @vueuse/components package. Learn more about the usage.

vue

<template>
  <UseGeolocation v-slot="{ coords: { latitude
, longitude
 } }">
    Latitude: {{ latitude
 }}
    Longitude: {{ longitude
 }}
  </UseGeolocation>
</template>

Type Declarations

export interface UseGeolocationOptions
  extends Partial
<PositionOptions>, ConfigurableNavigator {
  immediate
?: boolean
}
export interface UseGeolocationReturn extends Supportable {
  coords
: ShallowRef
<Omit
<GeolocationPosition["coords"], "toJSON">>
  locatedAt
: ShallowRef
<number | null>
  error
: ShallowRef
<GeolocationPositionError | null>
  resume
: () => void
  pause
: () => void
}
/**
 * Reactive Geolocation API.
 *
 * @see https://vueuse.org/useGeolocation
 * @param options
 */
export declare function useGeolocation
(
  options
?: UseGeolocationOptions,
): UseGeolocationReturn