Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.87 KB

index.md

File metadata and controls

37 lines (26 loc) · 1.87 KB
Raw
category
Sensors

useGeolocation

Reactive Geolocation API. It allows the user to provide their location to web applications if they so desire. For privacy reasons, the user is asked for permission to report location information.

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

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