https://github.com/cap-go/capacitor-nativegeocoder
Capacitor plugin for native forward and reverse geocoding
https://github.com/cap-go/capacitor-nativegeocoder
android capacitor capacitor-plugin geocoding swift
Last synced: 8 days ago
JSON representation
Capacitor plugin for native forward and reverse geocoding
- Host: GitHub
- URL: https://github.com/cap-go/capacitor-nativegeocoder
- Owner: Cap-go
- License: mit
- Created: 2022-06-29T10:58:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T18:44:00.000Z (about 1 year ago)
- Last Synced: 2025-05-09T17:45:43.646Z (about 1 year ago)
- Topics: android, capacitor, capacitor-plugin, geocoding, swift
- Language: Java
- Homepage:
- Size: 1.04 MB
- Stars: 28
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @capgo/capacitor-nativegeocoder
Capacitor plugin for native forward and reverse geocoding
## Documentation
The most complete doc is available here: https://capgo.app/docs/plugins/nativegeocoder/
## Compatibility
| Plugin version | Capacitor compatibility | Maintained |
| -------------- | ----------------------- | ---------- |
| v8.\*.\* | v8.\*.\* | ✅ |
| v7.\*.\* | v7.\*.\* | On demand |
| v6.\*.\* | v6.\*.\* | ❌ |
| v5.\*.\* | v5.\*.\* | ❌ |
> **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.
## Install
```bash
npm install @capgo/capacitor-nativegeocoder
npx cap sync
```
then import this into your code:
```javascript
import { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';
```
## iOS
Apple requires privacy descriptions to be specified in `Info.plist` for location information:
- `NSLocationAlwaysAndWhenInUseUsageDescription` (`Privacy - Location Always Usage Description`)
- `NSLocationWhenInUseUsageDescription` (`Privacy - Location When In Use Usage Description`)
Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode
The IOS implementation require internet
## Android
This API requires the following permissions be added to your `AndroidManifest.xml`:
```xml
```
## Web
This API requires a Google API key to be set in the `apiKey` field of the `ForwardOptions` or `ReverseOptions` interfaces.
There is no way to use this plugin on the web without a Google API key.
The return data is limited to the data available from the native API on the device, as example `formatted_address` is not available in web implementation, as it's not available in the native API.
## API
* [`reverseGeocode(...)`](#reversegeocode)
* [`forwardGeocode(...)`](#forwardgeocode)
* [`getPluginVersion()`](#getpluginversion)
* [Interfaces](#interfaces)
### reverseGeocode(...)
```typescript
reverseGeocode(options: ReverseOptions) => Promise<{ addresses: Address[]; }>
```
Convert latitude and longitude to an address
| Param | Type |
| ------------- | --------------------------------------------------------- |
| **`options`** | ReverseOptions |
**Returns:** Promise<{ addresses: Address[]; }>
**Since:** 0.0.1
--------------------
### forwardGeocode(...)
```typescript
forwardGeocode(options: ForwardOptions) => Promise<{ addresses: Address[]; }>
```
Convert an address to latitude and longitude
| Param | Type |
| ------------- | --------------------------------------------------------- |
| **`options`** | ForwardOptions |
**Returns:** Promise<{ addresses: Address[]; }>
**Since:** 0.0.1
--------------------
### getPluginVersion()
```typescript
getPluginVersion() => Promise<{ version: string; }>
```
Get the native Capacitor plugin version
**Returns:** Promise<{ version: string; }>
--------------------
### Interfaces
#### Address
| Prop | Type |
| --------------------------- | --------------------- |
| **`latitude`** | number |
| **`longitude`** | number |
| **`countryCode`** | string |
| **`countryName`** | string |
| **`postalCode`** | string |
| **`administrativeArea`** | string |
| **`subAdministrativeArea`** | string |
| **`locality`** | string |
| **`subLocality`** | string |
| **`thoroughfare`** | string |
| **`subThoroughfare`** | string |
| **`areasOfInterest`** | string[] |
#### ReverseOptions
| Prop | Type | Description |
| ------------------- | -------------------- | ------------------------------------------------------------------------ |
| **`latitude`** | number | latitude is a number representing the latitude of the location. |
| **`longitude`** | number | longitude is a number representing the longitude of the location. |
| **`useLocale`** | boolean | Localise the results to the given locale. |
| **`defaultLocale`** | string | locale is a string in the format of language_country, for example en_US. |
| **`maxResults`** | number | Max number of results to return. |
| **`apiKey`** | string | Only used for web platform to use google api |
| **`resultType`** | string | Only used for web platform to use google api |
#### ForwardOptions
| Prop | Type | Description |
| ------------------- | -------------------- | ------------------------------------------------------------------------ |
| **`addressString`** | string | address is a string of the address to be geocoded. |
| **`useLocale`** | boolean | Localise the results to the given locale. |
| **`defaultLocale`** | string | locale is a string in the format of language_country, for example en_US. |
| **`maxResults`** | number | Max number of results to return. |
| **`apiKey`** | string | Only used for web platform to use google api |
## Thanks
To [@sebastianbaar](https://github.com/sebastianbaar) and his work on [cordova-plugin-nativegeocoder](https://github.com/sebastianbaar/cordova-plugin-nativegeocoder) what he made was very inspiring