instantsearch-googlemaps
Advanced tools
Changelog
Readme
algolia/instantsearch.js widget to display your Algolia geo hits on a map using Google Maps APIs
Table of Contents generated with DocToc
instantsearch-googlemaps is available on jsDelivr:
Add the instantsearch CSS to the <head>:
<link rel="stylesheet" type="text/css" href="//cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.css" />
Load the JavaScript files where relevant:
<!-- https://developers.google.com/maps/documentation/javascript/tutorial -->
<script src="//maps.googleapis.com/maps/api/js?key=YOUR_API_KEY"></script>
<script src="//cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.js"></script>
<script src="//cdn.jsdelivr.net/instantsearch-googlemaps/1/instantsearch-googlemaps.min.js"></script>
npm install instantsearch-googlemaps --save
To display your objects on a map, they will need to have a _geoloc attribute.
{
"_geoloc": {"lat": 33.636719, "lng": -84.428067}
}
<script>var search = instantsearch({...});
search.addWidget(
instantsearch.widgets.googleMaps({
container: document.querySelector('#map'),
// prepareMarkerData
})
);
var instantsearch = require('instantsearch.js');
var instantsearchGoogleMaps = require('instantsearch-googlemaps');
var search = instantsearch({...});
search.addWidget(
instantsearchGoogleMaps({
container: document.querySelector('#map'),
// prepareMarkerData
})
);
Where to insert the map in the document. This is required.
Called for every hit, this is the moment where you can select the label and title
for the marker. This function should return an object in the form of {label, title}.
Example:
function prepareMarkerData(hit, index, hits) {
return {
label: hit.name,
title: hit.description
}
}
The label first letter will be displayed on the marker on the map.
The title will be displayed when hovering the marker.
By default we use the current hit index in the results as the label and the hit ObjectID for the title.
Should we refine the search on map interaction, default to false.
npm install
npm run dev
npm install
npm test
SEMVER_TOKEN=minor npm run release
FAQs
algolia/instantsearch.js widget to display your Algolia geo hits on a map using Google Maps APIs
The npm package instantsearch-googlemaps receives a total of 2 weekly downloads. As such, instantsearch-googlemaps popularity was classified as not popular.
We found that instantsearch-googlemaps demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.