Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-nativegeocoder`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/nativegeocoder/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

npm install @capgo/capacitor-nativegeocoder
npx cap sync

Import

import { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';

API Overview

`reverseGeocode`

Convert latitude and longitude to an address

import { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';

await NativeGeocoder.reverseGeocode({} as ReverseOptions);

`forwardGeocode`

Convert an address to latitude and longitude

import { NativeGeocoder } from '@capgo/capacitor-nativegeocoder';

await NativeGeocoder.forwardGeocode({} as ForwardOptions);

Type Reference

`ReverseOptions`

export interface ReverseOptions {
  /**
   * latitude is a number representing the latitude of the location.
   */
  latitude: number;
  /**
   * longitude is a number representing the longitude of the location.
   */
  longitude: number;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
  /**
   * Only used for web platform to use google api
   */
  resultType?: string;
}

`Address`

export interface Address {
  latitude: number;
  longitude: number;
  countryCode: string;
  countryName: string;
  postalCode: string;
  administrativeArea: string;
  subAdministrativeArea: string;
  locality: string;
  subLocality: string;
  thoroughfare: string;
  subThoroughfare: string;
  areasOfInterest: string[];
}

`ForwardOptions`

export interface ForwardOptions {
  /**
   * address is a string of the address to be geocoded.
   */
  addressString: string;
  /**
   * Localise the results to the given locale.
   */
  useLocale?: boolean;
  /**
   * locale is a string in the format of language_country, for example en_US.
   */
  defaultLocale?: string;
  /**
   * Max number of results to return.
   */
  maxResults?: number;
  /**
   * Only used for web platform to use google api
   */
  apiKey?: string;
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-nativegeocoder for the native capability in Using @capgo/capacitor-nativegeocoder, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.