Fork of @geoapify/react-geocoder-autocomplete) because project seems dead

React compoment for Geoapify Geocoder Autocomplete

The component wraps the @geoapify/geocoder-autocomplete library into a React component. The library uses Geoapify Geocoding Autocomplete as an address search service.

Geoapify Geocoding Autocomplete API

The component uses Geoapify Geocoding API for address search.

• Documentation
• Playground
• Register and get Geoapify API key
• Geoapify Location Platform

Geoapify Place Details API

On user select events the Place Details API is called to provide more details for the selected place and it's geometry. Note, that the Place Deatils API call costs additional "Geocoding & Places" request. Use the skipDetails option to skip the Places Details API call.

• Place Details API Documentation
• Place Details API Playground

Compatiblity table

@geoapify/react-geocoder-autocomplete	React
1.0.x	>= 16.8.0
1.1.x	>= 16.8.0
1.2.x	>= 17.0.0
1.3.x	>= 17.0.0

Installation

@geoapify/react-geocoder-autocomplete has a peer dependancy on @geoapify/geocoder-autocomplete:

npm install @geoapify/geocoder-autocomplete @geoapify/react-geocoder-autocomplete
# or 
yarn add @geoapify/geocoder-autocomplete @geoapify/react-geocoder-autocomplete

Usage

You need an API key to be able to call Geoapify Geocoding API. Register and get an API key for Free on myprojects.geoapify.com. Geoapify has Freemium pricing model. You can start for Free and extend when you need.

1. Import styles Import CSS style file from @geoapify-geocoder-autocomplete to make the control appear correctly. You can choose from several stylings:

• minimal and round-borders - for webpages with light background color
• minimal-dark and round-borders-dark for webpages with dark background color.

2. Add Geoapify context and provide an apiKey there
3. Add Geoapify Geocoder Autocomplete component

1import React, { useState } from 'react'
2import { GeoapifyGeocoderAutocomplete, GeoapifyContext } from '@geoapify/react-geocoder-autocomplete'
3import '@geoapify/geocoder-autocomplete/styles/minimal.css'
4
5const App = () => {
6  ...
7
8  function onPlaceSelect(value) {
9    console.log(value);
10  }
11
12  function onSuggectionChange(value) {
13    console.log(value);
14  }
15
16  function preprocessHook(value) {
17    return `${value}, Munich, Germany`
18  }
19
20  function postprocessHook(feature) {
21    return feature.properties.street;
22  }
23
24  function suggestionsFilter(suggestions) {
25    const processedStreets = [];
26
27    const filtered = suggestions.filter(value => {
28      if (!value.properties.street || processedStreets.indexOf(value.properties.street) >= 0) {
29        return false;
30      } else {
31        processedStreets.push(value.properties.street);
32        return true;
33      }
34    })
35
36    return filtered;
37  }
38
39  return <GeoapifyContext apiKey="YOUR_API_KEY_HERE">
40
41      <GeoapifyGeocoderAutocomplete
42        placeSelect={onPlaceSelect}
43        suggestionsChange={onSuggectionChange}
44      />
45
46      <GeoapifyGeocoderAutocomplete placeholder="Enter address here"
47        value={value}
48        type={type}
49        lang={language}
50        position={position}
51        countryCodes={countryCodes}
52        limit={limit}
53        filterByCountryCode={filterByCountryCode}
54        filterByCircle={filterByCircle}
55        filterByRect={filterByRect}
56        biasByCountryCode={biasByCountryCode}
57        biasByCircle={biasByCircle}
58        biasByRect={biasByRect}
59        biasByProximity={biasByProximity}
60        placeSelect={onPlaceSelect}
61        suggestionsChange={onSuggectionChange}
62      />
63
64      <GeoapifyGeocoderAutocomplete
65        placeSelect={onPlaceSelect}
66        suggestionsChange={onSuggectionChange}
67        preprocessHook={preprocessHook}
68        postprocessHook={postprocessHook}
69        suggestionsFilter={suggestionsFilter}
70      />
71    </GeoapifyContext>
72}
73
74export default App
75

Component properties

Name	Type	Description
value	string	Initial value or display value for the input field
type	LocationType	Type of a location
lang	SupportedLanguage	Results language
limit	number	The maximal number of returned suggestions
placeholder	string	An input field placeholder
filterByCountryCode	ByCountryCodeOptions	Search places in the countries
filterByCircle	ByCircleOptions	Search places inside the circle
filterByRect	ByRectOptions	Search places inside the rectangle
biasByCountryCode	ByCountryCodeOptions	First, search places in the countries
biasByCircle	ByCircleOptions	First, search places inside the circle
biasByRect	ByRectOptions	First, search places inside the rectangle
biasByProximity	ByProximityOptions	Prioritize results by farness from the location
skipIcons	boolean	Don't add icons to suggestions
skipDetails	boolean	Skip Place Details API call on selection change
position	GeoPosition	Prefered search position
countryCodes	CountyCode[]	Limit the search by countries

You can use several filters at once. The AND logic is applied to multiple filters.

You can use several bias parameters at once. The OR logic is applied to multiple biases.

1export type ByCountryCodeOptions = CountyCode[];
2
3export interface ByProximityOptions {
4    lon: number;
5    lat: number;
6}
7
8export interface ByCircleOptions {
9    lon: number;
10    lat: number;
11    radiusMeters: number;
12}
13
14export interface ByRectOptions {
15    lon1: number;
16    lat1: number;
17    lon2: number;
18    lat2: number;
19}
20
21export type LocationType = 'country' | 'state' | 'city' | 'postcode' | 'street' | 'amenity';
22export type SupportedLanguage = "ab" | "aa" | "af" | "ak" | "sq" | "am" | "ar" | "an" | "hy" | "as" | "av" | "ae" | "ay" | "az" | "bm" | "ba" | "eu" | "be" | "bn" | "bh" | "bi" | "bs" | "br" | "bg" | "my" | "ca" | "ch" | "ce" | "ny" | "zh" | "cv" | "kw" | "co" | "cr" | "hr" | "cs" | "da" | "dv" | "nl" | "en" | "eo" | "et" | "ee" | "fo" | "fj" | "fi" | "fr" | "ff" | "gl" | "ka" | "de" | "el" | "gn" | "gu" | "ht" | "ha" | "he" | "hz" | "hi" | "ho" | "hu" | "ia" | "id" | "ie" | "ga" | "ig" | "ik" | "io" | "is" | "it" | "iu" | "ja" | "jv" | "kl" | "kn" | "kr" | "ks" | "kk" | "km" | "ki" | "rw" | "ky" | "kv" | "kg" | "ko" | "ku" | "kj" | "la" | "lb" | "lg" | "li" | "ln" | "lo" | "lt" | "lu" | "lv" | "gv" | "mk" | "mg" | "ms" | "ml" | "mt" | "mi" | "mr" | "mh" | "mn" | "na" | "nv" | "nb" | "nd" | "ne" | "ng" | "nn" | "no" | "ii" | "nr" | "oc" | "oj" | "cu" | "om" | "or" | "os" | "pa" | "pi" | "fa" | "pl" | "ps" | "pt" | "qu" | "rm" | "rn" | "ro" | "ru" | "sa" | "sc" | "sd" | "se" | "sm" | "sg" | "sr" | "gd" | "sn" | "si" | "sk" | "sl" | "so" | "st" | "es" | "su" | "sw" | "ss" | "sv" | "ta" | "te" | "tg" | "th" | "ti" | "bo" | "tk" | "tl" | "tn" | "to" | "tr" | "ts" | "tt" | "tw" | "ty" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "cy" | "wo" | "fy" | "xh" | "yi" | "yo" | "za";
23
24export type CountyCode = "none"| "auto" | "ad" | "ae" | "af" | "ag" | "ai" | "al" | "am" | "an" | "ao" | "ap" | "aq" | "ar" | "as" | "at" | "au" | "aw" | "az" | "ba" | "bb" | "bd" | "be" | "bf" | "bg" | "bh" | "bi" | "bj" | "bm" | "bn" | "bo" | "br" | "bs" | "bt" | "bv" | "bw" | "by" | "bz" | "ca" | "cc" | "cd" | "cf" | "cg" | "ch" | "ci" | "ck" | "cl" | "cm" | "cn" | "co" | "cr" | "cu" | "cv" | "cx" | "cy" | "cz" | "de" | "dj" | "dk" | "dm" | "do" | "dz" | "ec" | "ee" | "eg" | "eh" | "er" | "es" | "et" | "eu" | "fi" | "fj" | "fk" | "fm" | "fo" | "fr" | "ga" | "gb" | "gd" | "ge" | "gf" | "gh" | "gi" | "gl" | "gm" | "gn" | "gp" | "gq" | "gr" | "gs" | "gt" | "gu" | "gw" | "gy" | "hk" | "hm" | "hn" | "hr" | "ht" | "hu" | "id" | "ie" | "il" | "in" | "io" | "iq" | "ir" | "is" | "it" | "jm" | "jo" | "jp" | "ke" | "kg" | "kh" | "ki" | "km" | "kn" | "kp" | "kr" | "kw" | "ky" | "kz" | "la" | "lb" | "lc" | "li" | "lk" | "lr" | "ls" | "lt" | "lu" | "lv" | "ly" | "ma" | "mc" | "md" | "me" | "mg" | "mh" | "mk" | "ml" | "mm" | "mn" | "mo" | "mp" | "mq" | "mr" | "ms" | "mt" | "mu" | "mv" | "mw" | "mx" | "my" | "mz" | "na" | "nc" | "ne" | "nf" | "ng" | "ni" | "nl" | "no" | "np" | "nr" | "nu" | "nz" | "om" | "pa" | "pe" | "pf" | "pg" | "ph" | "pk" | "pl" | "pm" | "pr" | "ps" | "pt" | "pw" | "py" | "qa" | "re" | "ro" | "rs" | "ru" | "rw" | "sa" | "sb" | "sc" | "sd" | "se" | "sg" | "sh" | "si" | "sj" | "sk" | "sl" | "sm" | "sn" | "so" | "sr" | "st" | "sv" | "sy" | "sz" | "tc" | "td" | "tf" | "tg" | "th" | "tj" | "tk" | "tm" | "tn" | "to" | "tr" | "tt" | "tv" | "tw" | "tz" | "ua" | "ug" | "um" | "us" | "uy" | "uz" | "va" | "vc" | "ve" | "vg" | "vi" | "vn" | "vu" | "wf" | "ws" | "ye" | "yt" | "za" | "zm" | "zw";

Component event properties

Name	Description	Value type
placeSelect	Fired when a location was selected	GeoJSON.Feature
suggestionsChange	Fired on new suggestions	[GeoJSON.Feature[]] (https://geojson.org/)

Properties of the feature contain information about address and location. Learn more about Geocoder result properties on Geoapify Documentation page.

The component doesn't have dependancy on @types/geojson. However, you can install it to work with GeoJSON types.

Hooks and filters

Name	Description
preprocessingHook	Modify the text to search. For example, if you expect that the user enters a street name you can add a city or postcode to search streets in the city.
postprocessingHook	Modify the text that will be displayed in the input field and suggestions list. For example, you can show only a street name.
suggestionsFilter	Filtering some suggestions. It lets to avoid duplicated results when you modify the address with a post-process hook. For example, suggestions may contain several addresses with the same street name, they will be duplicated when not the whole address but only the street name is shown.