-
Notifications
You must be signed in to change notification settings - Fork 9
feat: Migrates the event-poi sample to js-api-samples. #1135
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Google Maps JavaScript Sample | ||
|
|
||
| ## event-poi | ||
|
|
||
| This example demonstrates the use of click event listeners on POIs (points of interest). | ||
|
|
||
| ## Setup | ||
|
|
||
| ### Before starting run: | ||
|
|
||
| `npm i` | ||
|
|
||
| ### Run an example on a local web server | ||
|
|
||
| `cd samples/event-poi` | ||
| `npm start` | ||
|
|
||
| ### Build an individual example | ||
|
|
||
| `cd samples/event-poi` | ||
| `npm run build` | ||
|
|
||
| From 'samples': | ||
|
|
||
| `npm run build --workspace=event-poi/` | ||
|
|
||
| ### Build all of the examples. | ||
|
|
||
| From 'samples': | ||
|
|
||
| `npm run build-all` | ||
|
|
||
| ### Run lint to check for problems | ||
|
|
||
| `cd samples/event-poi` | ||
| `npx eslint index.ts` | ||
|
|
||
| ## Feedback | ||
|
|
||
| For feedback related to this sample, please open a new issue on | ||
| [GitHub](https://github.com/googlemaps-samples/js-api-samples/issues). |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| <!doctype html> | ||
| <!-- | ||
| @license | ||
| Copyright 2026 Google LLC. All Rights Reserved. | ||
| SPDX-License-Identifier: Apache-2.0 | ||
| --> | ||
| <!-- [START maps_event_poi] --> | ||
| <html> | ||
| <head> | ||
| <title>POI Click Events</title> | ||
|
|
||
| <link rel="stylesheet" type="text/css" href="./style.css" /> | ||
| <script type="module" src="./index.js"></script> | ||
| <!-- prettier-ignore --> | ||
| <script>(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: "AIzaSyA6myHzS10YXdcazAFalmXvDkrYCp5cLc8", v: "weekly"});</script> | ||
| </head> | ||
| <body> | ||
| <gmp-map center="-33.871, 151.197" zoom="18"> | ||
| <div id="infowindow-content"></div> | ||
| </gmp-map> | ||
| </body> | ||
| </html> | ||
| <!-- [END maps_event_poi] --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2026 Google LLC. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| // [START maps_event_poi] | ||
| const mapElement = document.querySelector('gmp-map') as google.maps.MapElement; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unless you prefer to define variables globally for samples, I would define this in initMap just before its used on line 16. |
||
| let innerMap; | ||
| let infowindow: google.maps.InfoWindow; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How do you feel about avoiding global variables? Let infowindow be declared on line 19 and pass it in as a parameter to showInfoWindow on line 27? |
||
|
|
||
| async function initMap() { | ||
| // Request the needed libraries. | ||
| await google.maps.importLibrary('maps'); | ||
|
|
||
| innerMap = await mapElement.innerMap; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The await on its a lot like writing await 0;
innerMap = mapElement.innerMap;Which does things regarding processing the javascript event loop, but maybe shouldn't be used for a sample? Does this work without it? if it does I think it should be removed. If not, I think we should promote another way to check for when custom-components are upgraded into theirselves (and then will have all their properties and what not set). Below is something I copied from a google search about how you wait for web components to be defined. async function waitForComponent(tagName: string): Promise<void> {
// customElements.whenDefined returns a Promise
await customElements.whenDefined(tagName);
console.log(`${tagName} is defined and ready to be used`);
}
// Usage
(async () => {
await waitForComponent('gmp-map');
// Initialize component logic here, access properties etc...
})(); |
||
|
|
||
| // Create the initial InfoWindow. | ||
| infowindow = new google.maps.InfoWindow({}); | ||
|
|
||
| innerMap.addListener('click', (event) => { | ||
| // Prevent the default POI info window from showing. | ||
| event.stop(); | ||
|
|
||
| // If the event has a placeId, show the info window. | ||
| if (isIconMouseEvent(event) && event.placeId) { | ||
| showInfoWindow(event); | ||
| } else { | ||
| // Otherwise, close the info window. | ||
| infowindow.close(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| // Helper function to show the info window. | ||
| async function showInfoWindow(event: google.maps.IconMouseEvent) { | ||
| // Retrieve the place details for the selected POI. | ||
| const place = await getPlaceDetails(event.placeId); | ||
|
|
||
| // Assemble the info window content. | ||
| const content = document.createElement('div'); | ||
| const address = document.createElement('div'); | ||
| const placeId = document.createElement('div'); | ||
| address.textContent = place.formattedAddress || ''; | ||
| placeId.textContent = place.id || ''; | ||
| content.append(address, placeId); | ||
|
|
||
| // Create an element to use the place name as header content. | ||
| const name = document.createElement('div'); | ||
| name.style.fontWeight = 'bold'; | ||
| name.style.fontSize = 'medium'; | ||
| name.textContent = place.displayName || ''; | ||
|
|
||
| // Update info window options. | ||
| infowindow.setOptions({ | ||
| position: event.latLng, | ||
| pixelOffset: new google.maps.Size(0, -30), | ||
| headerContent: name, | ||
| content: content, | ||
| }); | ||
|
|
||
| innerMap.panTo(event.latLng); | ||
| infowindow.open(innerMap); | ||
| } | ||
|
|
||
| // Helper function to get place details. | ||
| async function getPlaceDetails(placeId) { | ||
| // Import the Places library. | ||
| const { Place } = (await google.maps.importLibrary( | ||
| 'places' | ||
| )) as google.maps.PlacesLibrary; | ||
|
|
||
| // Create a Place instance with the place id and fetch the details. | ||
| const place = new Place({ id: placeId }); | ||
| await place.fetchFields({ | ||
| fields: ['displayName', 'formattedAddress'], | ||
| }); | ||
|
|
||
| // Return the place details. | ||
| return place; | ||
| } | ||
|
|
||
| // Helper type guard to determine if the event is an IconMouseEvent. | ||
| function isIconMouseEvent( | ||
| e: google.maps.MapMouseEvent | google.maps.IconMouseEvent | ||
| ): e is google.maps.IconMouseEvent { | ||
| return 'placeId' in e; | ||
| } | ||
|
|
||
| initMap(); | ||
| // [END maps_event_poi] | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "name": "@js-api-samples/event-poi", | ||
| "version": "1.0.0", | ||
| "scripts": { | ||
| "build": "tsc && bash ../jsfiddle.sh event-poi && bash ../app.sh event-poi && bash ../docs.sh event-poi && npm run build:vite --workspace=. && bash ../dist.sh event-poi", | ||
| "test": "tsc && npm run build:vite --workspace=.", | ||
| "start": "tsc && vite build --base './' && vite", | ||
| "build:vite": "vite build --base './'", | ||
| "preview": "vite preview" | ||
| }, | ||
| "dependencies": { | ||
|
|
||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2026 Google LLC. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| /* [START maps_event_poi] */ | ||
|
|
||
| /* Optional: Makes the sample page fill the window. */ | ||
| html, | ||
| body { | ||
| height: 100%; | ||
| margin: 0; | ||
| padding: 0; | ||
| } | ||
|
|
||
| .title { | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| #infowindow-content { | ||
| display: none; | ||
| } | ||
|
|
||
| #map #infowindow-content { | ||
| display: inline; | ||
| } | ||
|
|
||
| /* [END maps_event_poi] */ |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "compilerOptions": { | ||
| "module": "esnext", | ||
| "target": "esnext", | ||
| "strict": true, | ||
| "noImplicitAny": false, | ||
| "lib": [ | ||
| "es2015", | ||
| "esnext", | ||
| "es6", | ||
| "dom", | ||
| "dom.iterable" | ||
| ], | ||
| "moduleResolution": "Node", | ||
| "jsx": "preserve" | ||
| } | ||
| } |
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding the "div" on line 20 - This doesn't appear to be used in any way? I see there are css styles referencing it, but I cannot find any references to this in the sample code leading me to believe its unused? Let me know if I am missing something here.