Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: remove algolia provider #402

Merged
merged 1 commit into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Map from './components/Map';

`leaflet-geosearch` adds support for geocoding (address lookup, a.k.a. geoseaching) to your (web) application. It comes with controls to be embedded in your Leaflet map.

We support the following providers out-of-the-box; [Algolia](./providers/algolia), [Bing](./providers/bing), [Esri](./providers/esri), [Google](./providers/google), [OpenStreetMap](./providers/openstreetmap), [LocationIQ](./providers/locationiq), [OpenCage](./providers/opencage).
We support the following providers out-of-the-box: [Bing](./providers/bing), [Esri](./providers/esri), [Google](./providers/google), [OpenStreetMap](./providers/openstreetmap), [LocationIQ](./providers/locationiq), [OpenCage](./providers/opencage).

Although this project is named `leaflet-geosearch`, this library is also usable without LeafletJS, and does not have any dependencies on Leaflet whatsoever.

Expand Down Expand Up @@ -85,7 +85,7 @@ map.addControl(search);

`leaflet-geosearch` uses so-called "providers" to take care of building the correct service URL and parsing the retrieved data into a uniform format. Thanks to this architecture, it is trivial to add your own providers, so you can use your own geocoding service.

When [`OpenStreetMap`](./providers/openstreetmap) does not match your needs; you can also choose to use the [Algolia](./providers/algolia), [`Bing`](./providers/bing), [`Esri`](./providers/esri), [`Google`](./providers/google), [`LocationIQ`](./providers/locationiq), or [`OpenCage`](./providers/opencage) providers. Most of those providers do however require `API keys`. See the documentation pages on the relevant organisations on how to obtain these keys.
When [`OpenStreetMap`](./providers/openstreetmap) does not match your needs; you can also choose to use the [`Bing`](./providers/bing), [`Esri`](./providers/esri), [`Google`](./providers/google), [`LocationIQ`](./providers/locationiq), or [`OpenCage`](./providers/opencage) providers. Most of those providers do however require `API keys`. See the documentation pages on the relevant organisations on how to obtain these keys.

In case you decide to write your own provider, please consider submitting a PR to share your work with us.

Expand Down
3 changes: 0 additions & 3 deletions docs/lib/providers.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {
AlgoliaProvider,
BingProvider,
EsriProvider,
GeocodeEarthProvider,
Expand All @@ -15,8 +14,6 @@ import {
} from 'leaflet-geosearch';

export default {
Algolia: new AlgoliaProvider(),

Bing: new BingProvider({
params: { key: process.env.GATSBY_BING_API_KEY },
}),
Expand Down
34 changes: 0 additions & 34 deletions docs/providers/algolia.mdx

This file was deleted.

1 change: 0 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ export { default as GeoSearchControl } from './SearchControl';
export { default as SearchControl } from './SearchControl';
export { default as SearchElement } from './SearchElement';

export { default as AlgoliaProvider } from './providers/algoliaProvider';
export { default as BingProvider } from './providers/bingProvider';
export { default as EsriProvider } from './providers/esriProvider';
export { default as GeocodeEarthProvider } from './providers/geocodeEarthProvider';
Expand Down
20 changes: 0 additions & 20 deletions src/providers/__tests__/algoliaProvider.spec.js

This file was deleted.

Loading
Loading