Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douglasjunior/react-native-get-location
⚛ Simple to use React Native library to get native device location for Android and iOS.
https://github.com/douglasjunior/react-native-get-location
android gps hacktoberfest ios location react-native
Last synced: 7 days ago
JSON representation
⚛ Simple to use React Native library to get native device location for Android and iOS.
- Host: GitHub
- URL: https://github.com/douglasjunior/react-native-get-location
- Owner: douglasjunior
- License: mit
- Created: 2019-01-30T14:19:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T01:26:12.000Z (2 months ago)
- Last Synced: 2024-09-14T14:59:39.930Z (about 2 months ago)
- Topics: android, gps, hacktoberfest, ios, location, react-native
- Language: Java
- Homepage: https://www.npmjs.com/package/react-native-get-location
- Size: 1.03 MB
- Stars: 204
- Watchers: 3
- Forks: 42
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# React-Native Get Location
[](https://github.com/douglasjunior/react-native-get-location/blob/master/LICENSE)
[](https://www.npmjs.com/package/react-native-get-location)
[](https://www.npmjs.com/package/react-native-get-location?activeTab=versions)
⚛ Simple to use React Native library to get native device location for Android and iOS.
## Requirements
- React Native >= 0.60.0
- iOS >= 9.0
## Install
Install dependency package
```bash
yarn add react-native-get-location
```
Or
```bash
npm i -S react-native-get-location
```
Go to the folder **your-project/ios** and run `pod install`, and you're done.
## Android post install
For Android you need to define the location permissions on `AndroidManifest.xml`.
```xml
```
## iOS post install
You need to define the permission [NSLocationWhenInUseUsageDescription](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW26) on `Info.plist`.
```xml
NSLocationWhenInUseUsageDescription
This app needs to get your location...
```
## Usage
There is only one function that you need to use to get the user's current location.
```js
import GetLocation from 'react-native-get-location'
GetLocation.getCurrentPosition({
enableHighAccuracy: true,
timeout: 60000,
})
.then(location => {
console.log(location);
})
.catch(error => {
const { code, message } = error;
console.warn(code, message);
})
```
For more details, see the [Sample Project](https://github.com/douglasjunior/react-native-get-location/blob/master/Sample/App.tsx).
## API
### function `GetLocation.getCurrentPosition(LocationConfig)`
**Parameters:**
- [`LocationConfig`](#object-locationconfig): Configuration object to determine how to get the user current location.
**Return:**
- `Promise<`[`Location`](#object-location)`>`: Promise thats resolve to a Location object.
### Object `LocationConfig`
**Properties:**
- `enableHighAccuracy`: Set `true` to use 'fine location' (GPS) our `false` to use 'course location' (Wifi, Bluetooth, 3G). Default: `false`
- `timeout`: The max time (in milliseconds) that you want to wait to receive a location. Default: `60000` (60 seconds)
- `rationale?`: (Android only) See the [React Native docs](https://reactnative.dev/docs/permissionsandroid#request).
### Object `Location`
**Properties:**
- `latitude`: The latitude, in degrees.
- `longitude`: The longitude, in degrees.
- `altitude`: The altitude if available, in meters above the WGS 84 reference ellipsoid.
- `accuracy`: The estimated horizontal accuracy of this location, radial, in meters.
- `speed`: The speed if it is available, in meters/second over ground.
- `time`: The UTC time of this fix, in milliseconds since January 1, 1970.
- `bearing`: *(Android only)* The bearing, in degrees.
- `provider`: *(Android only)* The name of the provider that generated this fix.
- `verticalAccuracy`: *(iOS only)* The vertical accuracy of the location. Negative if the altitude is invalid.
- `course`: *(iOS only)* The course of the location in degrees true North. Negative if course is invalid. (0.0 - 359.9 degrees, 0 being true North)
### Error codes
|Code|Message|
|-|-|
|`CANCELLED`|Location cancelled by user or by another request|
|`UNAVAILABLE`|Location service is disabled or unavailable|
|`TIMEOUT`|Location request timed out|
|`UNAUTHORIZED`|Authorization denied|
## Contribute
New features, bug fixes and improvements are welcome! For questions and suggestions use the [issues](https://github.com/douglasjunior/react-native-get-location/issues).
[](https://paypal.me/douglasnassif)
## Star History
[](https://star-history.com/#douglasjunior/react-native-get-location)
## License
```
The MIT License (MIT)
Copyright (c) 2019 Douglas Nassif Roma Junior
```
See the full [license file](https://github.com/douglasjunior/react-native-get-location/blob/master/LICENSE).