diff --git a/.env.sample b/.env.sample index 4845f2c99..0212a7e78 100644 --- a/.env.sample +++ b/.env.sample @@ -1,7 +1,7 @@ +AMAP_API_KEY=___YOUR_KEY___ BING_API_KEY=___YOUR_KEY___ +GEOAPIFY_API_KEY=___YOUR_KEY___ GOOGLE_API_KEY=___YOUR_KEY___ +HERE_API_KEY=___YOUR_KEY___ LOCATIONIQ_API_KEY=___YOUR_KEY___ OPENCAGE_API_KEY=___YOUR_KEY___ -HERE_API_KEY=___YOUR_KEY___ -AMAP_API_KEY=___YOUR_KEY___ -GEOAPIFY_API_KEY=___YOUR_KEY___ diff --git a/README.md b/README.md index 4cfe1a422..ae9c5a0b5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Leaflet.GeoSearch + [![All Contributors](https://img.shields.io/badge/all_contributors-58-orange.svg?style=flat-square)](#contributors-) + **Demo and Docs: [smeijer.github.io/leaflet-geosearch](https://smeijer.github.io/leaflet-geosearch)** @@ -10,7 +12,7 @@ ## Installation -**more docs @** https://smeijer.github.io/leaflet-geosearch/#installation +**more docs @** with npm: @@ -26,7 +28,7 @@ yarn add leaflet-geosearch ## Browser support / Polyfills -**more docs @** https://smeijer.github.io/leaflet-geosearch/#browser-support--polyfills +**more docs @** This library is written with the latest technologies in mind. Thereby it is required to include some polyfills when you wish to support older browsers. These polyfills are recommended for IE and Safari support: @@ -48,6 +50,7 @@ your own geocoding service(s). The control comes with a number of default providers: - [Algolia] +- [AMap] - [Bing] - [Esri] - [Geocode Earth] @@ -65,7 +68,7 @@ usable without LeafletJS, and does not have any dependencies whatsoever. # Usage -**more docs @** https://smeijer.github.io/leaflet-geosearch/usage +**more docs @** Let's first start with an little example on how to use this control without leaflet. For example as an address lookup on a webshop order form. Perhaps to @@ -341,6 +344,7 @@ refresh when you change source files. [babel-polyfill]: https://npmjs.com/babel-polyfill [unfetch]: https://npmjs.com/unfetch [algolia]: https://smeijer.github.io/leaflet-geosearch/providers/algolia +[AMap]: https://smeijer.github.io/leaflet-geosearch/providers/amap [bing]: https://smeijer.github.io/leaflet-geosearch/providers/bing [esri]: https://smeijer.github.io/leaflet-geosearch/providers/esri [geocode earth]: https://smeijer.github.io/leaflet-geosearch/providers/geocode-earth diff --git a/docs/lib/providers.ts b/docs/lib/providers.ts index baa9c3d17..61285d9e3 100644 --- a/docs/lib/providers.ts +++ b/docs/lib/providers.ts @@ -1,6 +1,9 @@ import { + AMapProvider, BingProvider, EsriProvider, + GeoApiFrProvider, + GeoapifyProvider, GeocodeEarthProvider, GoogleProvider, LegacyGoogleProvider, @@ -9,18 +12,24 @@ import { OpenCageProvider, OpenStreetMapProvider, PeliasProvider, - GeoApiFrProvider, - GeoapifyProvider, - AMapProvider, } from 'leaflet-geosearch'; export default { + AMap: new AMapProvider({ + params: { key: process.env.GATSBY_AMAP_API_KEY }, + }), Bing: new BingProvider({ params: { key: process.env.GATSBY_BING_API_KEY }, }), Esri: new EsriProvider(), + GeoApiFr: new GeoApiFrProvider(), + + Geoapify: new GeoapifyProvider({ + params: { apiKey: process.env.GATSBY_GEOAPIFY_API_KEY }, + }), + GeocodeEarth: new GeocodeEarthProvider({ params: { api_key: process.env.GATSBY_GEOCODEEARTH_API_KEY }, }), @@ -43,17 +52,7 @@ export default { params: { key: process.env.GATSBY_OPENCAGE_API_KEY }, }), - Geoapify: new GeoapifyProvider({ - params: { apiKey: process.env.GATSBY_GEOAPIFY_API_KEY }, - }), - OpenStreetMap: new OpenStreetMapProvider(), Pelias: new PeliasProvider(), - - GeoApiFr: new GeoApiFrProvider(), - - AMap: new AMapProvider({ - params: { key: process.env.GATSBY_AMAP_API_KEY }, - }), }; diff --git a/src/index.ts b/src/index.ts index cebed54e3..20e177bfc 100644 --- a/src/index.ts +++ b/src/index.ts @@ -2,20 +2,20 @@ export { default as GeoSearchControl } from './SearchControl'; export { default as SearchControl } from './SearchControl'; export { default as SearchElement } from './SearchElement'; +export { default as AMapProvider } from './providers/amapProvider'; export { default as BingProvider } from './providers/bingProvider'; +export { default as CivilDefenseMapProvider } from './providers/civilDefenseMapProvider'; export { default as EsriProvider } from './providers/esriProvider'; +export { default as GeoApiFrProvider } from './providers/geoApiFrProvider'; +export { default as GeoapifyProvider } from './providers/geoapifyProvider'; export { default as GeocodeEarthProvider } from './providers/geocodeEarthProvider'; export { default as GoogleProvider } from './providers/googleProvider'; export { default as LegacyGoogleProvider } from './providers/legacyGoogleProvider'; export { default as HereProvider } from './providers/hereProvider'; export { default as LocationIQProvider } from './providers/locationIQProvider'; +export { default as MapBoxProvider } from './providers/mapBoxProvider'; export { default as OpenCageProvider } from './providers/openCageProvider'; export { default as OpenStreetMapProvider } from './providers/openStreetMapProvider'; -export { default as CivilDefenseMapProvider } from './providers/civilDefenseMapProvider'; export { default as PeliasProvider } from './providers/peliasProvider'; -export { default as MapBoxProvider } from './providers/mapBoxProvider'; -export { default as GeoApiFrProvider } from './providers/geoApiFrProvider'; -export { default as GeoapifyProvider } from './providers/geoapifyProvider'; -export { default as AMapProvider } from './providers/amapProvider'; export { default as JsonProvider } from './providers/provider'; diff --git a/src/providers/civilDefenseMapProvider.ts b/src/providers/civilDefenseMapProvider.ts index 5d495e2f1..dfde4a520 100644 --- a/src/providers/civilDefenseMapProvider.ts +++ b/src/providers/civilDefenseMapProvider.ts @@ -5,7 +5,6 @@ import AbstractProvider, { RequestType, SearchResult, } from './provider'; -import hasShape from '../lib/hasShape'; export type RequestResult = RawResult[]; diff --git a/src/providers/index.ts b/src/providers/index.ts index 56b5b5cd3..470f52f68 100644 --- a/src/providers/index.ts +++ b/src/providers/index.ts @@ -1,15 +1,17 @@ +export { default as AMapProvider } from './amapProvider'; export { default as BingProvider } from './bingProvider'; +export { default as CivilDefenseMapProvider } from './civilDefenseMapProvider'; export { default as EsriProvider } from './esriProvider'; +export { default as GeoApiFrProvider } from './geoApiFrProvider'; +export { default as GeoapifyProvider } from './geoapifyProvider'; export { default as GeocodeEarthProvider } from './geocodeEarthProvider'; export { default as GoogleProvider } from './googleProvider'; export { default as LegacyGoogleProvider } from './legacyGoogleProvider'; +export { default as HereProvider } from './hereProvider'; export { default as LocationIQProvider } from './locationIQProvider'; +export { default as MapBoxProvider } from './mapBoxProvider'; export { default as OpenCageProvider } from './openCageProvider'; export { default as OpenStreetMapProvider } from './openStreetMapProvider'; -export { default as CivilDefenseMapProvider } from './civilDefenseMapProvider'; export { default as PeliasProvider } from './peliasProvider'; -export { default as MapBoxProvider } from './mapBoxProvider'; -export { default as GeoApiFrProvider } from './geoApiFrProvider'; -export { default as GeoapifyProvider } from './geoapifyProvider'; export { default as Provider } from './provider'; diff --git a/src/providers/openStreetMapProvider.ts b/src/providers/openStreetMapProvider.ts index c8982cfac..9ccf03b0b 100644 --- a/src/providers/openStreetMapProvider.ts +++ b/src/providers/openStreetMapProvider.ts @@ -5,7 +5,6 @@ import AbstractProvider, { RequestType, SearchResult, } from './provider'; -import hasShape from '../lib/hasShape'; export type RequestResult = RawResult[];