UNPKG

@hooks/geo-location

Version:

React hook to return geo location details

32 lines (19 loc) • 722 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 🎒 @hooks/geo-location React hook to return geo location details ![NPM version](https://img.shields.io/npm/v/@hooks/geo-location?style=flat-square) ![Travis](https://img.shields.io/travis/com/simmo/hooks?style=flat-square) ![License](https://img.shields.io/npm/l/@hooks/geo-location?style=flat-square) ## Install ```bash npm i @hooks/geo-location ``` ## Usage ### useGeoLocation ```ts useGeoLocation(options?: PositionOptions): [Position, PositionError] ``` #### Parameters ##### `options?: PositionOptions` Passes PositionOptions through to the geolocation API - https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions #### Return Returns an array containing the position and any position error.