Skip to content

clurts/use-location

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

use-location

Installation

To install using npm:

npm i @clurts/use-location

To install using yarn:

yarn add @clurts/use-location

Usage

Import the useLocation hook:

import useLocation from "@clurts/use-location"

In your component use as follows:

const [isLocating, position, error] = useLocation()

Api

isLocating: boolean - indicates wehter or not your postion is being retrieved currently.

position: object - containing geolocation information

Properties on the position object:

Property Description
lat Returns the current position latitude
long Returns the current position longitude

error: string - error messages if access to location data is blocked or geolocation is not supported by the browser.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published