Store Locator Library for Maps API

This library enables developers to easily build store locator-type applications using the Google Maps API.

The library provides the following features:

Examples/Demos

The best way to become acquainted with the library is to see some of the examples:

  1. panel.html – A simple store locator, including panel. Data is fetched from a static CSV file.
  2. dynamic.html – Same as above, except stores are fetched dynamically from a JSONP web service.
  3. gme.html – Same as above, except stores are fetched dynamically from Google Maps Engine.
  4. custom.html – Various customisations to the default UI including custom markers and info window.
  5. places.html – Places are searched using the Google Places API, and displayed as a store locator.

Reference documentation

For detailed documentation on the library, including classes, events and sample usage, please see the reference documentation.

Quick Start

To get started, include the store-locator.min.js file on your HTML page. A set of CSS styles are also available, which provide styling for store details and side panel.

The library's functions are contained under the storeLocator namespace. The main class is called storeLocator.View. A View has two required parameters, a google.maps.Map, and a storeLocator.DataFeed.

A DataFeed is an object with the function getStores. This function is called each time the map needs an update. A simple example of a DataFeed can be found in the reference.