Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 3.49 KB

README.md

File metadata and controls

68 lines (51 loc) · 3.49 KB

react-geocode

A React module to transform a description of a location (i.e. street address, town name, etc.) into geographic coordinates (i.e. latitude and longitude) and vice versa.

This module uses Google Maps Geocoding API and requires an API key for purposes of quota management. Please check this link out to obtain your API key.

Install

npm install --save react-geocode

or

yarn add react-geocode

Example

import Geocode from 'react-geocode';

// set Google Maps Geocoding API for purposes of quota management. Its optional but recommended.
Geocode.setApiKey('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx');

// set response language. Defaults to english.
Geocode.setLanguage('en');

// Enable or disable logs. Its optional.
Geocode.enableDebug();

// Get address from latidude & longitude.
Geocode.fromLatLng('48.8583701', '2.2922926').then(
  response => {
    const address = response.results[0].formatted_address;
    console.log(address);
  },
  error => {
    console.error(error);
  }
);

// Get latidude & longitude from address.
Geocode.fromAddress('Eiffel Tower').then(
  response => {
    const { lat, lng } = response.results[0].geometry.location;
    console.log(lat, lng);
  },
  error => {
    console.error(error);
  }
);

Methods

Method Arguments Params Type Description
setApiKey api_key - function set Google Maps Geocoding API for purposes of quota management. Its optional but recommended
setLanguage language code - function Specify language of the parsed address. List of the available language codes. Defaults to english
enableDebug true or false - function Enable or disable logs. Its optional.
fromLatLng latitude and longitude response function Get address from latidude & longitude.
fromAddress address response function Get latidude & longitude from address.

Follow me on Twitter: @shukerullah

Buy Me A Coffee