Add a Map with Events using HTML

  • This example demonstrates how to add event handling to gmp-advanced-marker elements using the Google Maps JavaScript API.

  • Clicking a marker on the map triggers a 'gmp-click' event, opening an InfoWindow displaying the marker's title.

  • The provided code snippets showcase the implementation in both TypeScript and JavaScript, along with HTML and CSS for styling and structure.

  • The sample utilizes Google Maps Web Components for creating interactive map elements.

  • You can interact with the live sample via JSFiddle or Google Cloud Shell, and clone the code for local execution using Git and Node.js.

This example demonstrates adding event handling to some gmp-advanced-marker elements, to show an InfoWindow when a marker is clicked.

Read the documentation.

TypeScript

// This example adds a map using web components.
async function init(): Promise<void> {
    void google.maps.importLibrary('marker'); // preload
    const { InfoWindow } = await google.maps.importLibrary('maps');

    console.log('Maps JavaScript API loaded.');

    const advancedMarkers = document.querySelectorAll(
        '#marker-click-event-example gmp-advanced-marker'
    ) as Iterable<google.maps.marker.AdvancedMarkerElement>;

    for (const advancedMarker of advancedMarkers) {
        void customElements.whenDefined(advancedMarker.localName).then(() => {
            advancedMarker.addEventListener('gmp-click', () => {
                const infoWindow = new InfoWindow({
                    content: advancedMarker.title,
                });

                infoWindow.open({
                    anchor: advancedMarker,
                });
            });
        });
    }
}

void init();

JavaScript

// This example adds a map using web components.
async function init() {
    void google.maps.importLibrary('marker'); // preload
    const { InfoWindow } = await google.maps.importLibrary('maps');

    console.log('Maps JavaScript API loaded.');

    const advancedMarkers = document.querySelectorAll(
        '#marker-click-event-example gmp-advanced-marker'
    );

    for (const advancedMarker of advancedMarkers) {
        void customElements.whenDefined(advancedMarker.localName).then(() => {
            advancedMarker.addEventListener('gmp-click', () => {
                const infoWindow = new InfoWindow({
                    content: advancedMarker.title,
                });

                infoWindow.open({
                    anchor: advancedMarker,
                });
            });
        });
    }
}

void init();

CSS

/* 
 * Optional: Makes the sample page fill the window. 
 */
html,
body {
    height: 100%;
    margin: 0;
    padding: 0;
}

HTML

<html>
    <head>
        <title>Add a Map Web Component with Events</title>

        <link rel="stylesheet" type="text/css" href="./style.css" />
        <script type="module" src="./index.js"></script>
        <script>
            // prettier-ignore
            (g=>{var h,a,k,p="The Google Maps JavaScript API",c="google",l="importLibrary",q="__ib__",m=document,b=window;b=b[c]||(b[c]={});var d=b.maps||(b.maps={}),r=new Set,e=new URLSearchParams,u=()=>h||(h=new Promise(async(f,n)=>{await (a=m.createElement("script"));e.set("libraries",[...r]+"");for(k in g)e.set(k.replace(/[A-Z]/g,t=>"_"+t[0].toLowerCase()),g[k]);e.set("callback",c+".maps."+q);a.src=`https://maps.${c}apis.com/maps/api/js?`+e;d[q]=f;a.onerror=()=>h=n(Error(p+" could not load."));a.nonce=m.querySelector("script[nonce]")?.nonce||"";m.head.append(a)}));d[l]?console.warn(p+" only loads once. Ignoring:",g):d[l]=(f,...n)=>r.add(f)&&u().then(()=>d[l](f,...n))})({
                key: "GOOGLE_MAPS_API_KEY"
            });
        </script>
    </head>
    <body>
        <gmp-map
            id="marker-click-event-example"
            center="43.4142989,-124.2301242"
            zoom="4"
            map-id="DEMO_MAP_ID">
            <gmp-advanced-marker
                position="37.4220656,-122.0840897"
                title="Mountain View, CA"
                gmp-clickable></gmp-advanced-marker>
            <gmp-advanced-marker
                position="47.648994,-122.3503845"
                title="Seattle, WA"
                gmp-clickable></gmp-advanced-marker>
        </gmp-map>
    </body>
</html>

Clone Sample

Git and Node.js are required to run this sample locally. Follow these instructions to install Node.js and NPM. You will also need a Google Maps API key.

The following commands clone the repository, install dependencies, and copy the environment file. 

  git clone https://github.com/googlemaps-samples/js-api-samples.git
  cd js-api-samples
  npm i
  cp .env.template .env

Once you copy the environment file, make sure to open the .env file and replace <Insert your own development API key here> with your actual API key before starting the sample. 

  cd samples/web-components-events
  npm start