Places Widgets

Stay organized with collections Save and categorize content based on your preferences.

PlaceAutocompleteElement class

google.maps.places.PlaceAutocompleteElement class

PlaceAutocompleteElement is an HTMLElement subclass which provides a UI component for the Places Autocomplete API.

PlaceAutocompleteElement automatically uses AutocompleteSessionTokens internally to group the query and selection phases of a user's autocomplete search.

The first call to Place.fetchFields on a Place returned by PlacePrediction.toPlace will automatically include the session token used to fetch the PlacePrediction.

See https://developers.google.com/maps/documentation/places/web-service/place-session-tokens for more details on how sessions work.

Custom element:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng" requested-language="string" requested-region="string" unit-system="metric"></gmp-place-autocomplete>

This class extends HTMLElement.

This class implements PlaceAutocompleteElementOptions.

Access by calling const {PlaceAutocompleteElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceAutocompleteElementOptions interface

google.maps.places.PlaceAutocompleteElementOptions interface

Options for constructing a PlaceAutocompleteElement. For the description of each property, refer to the property of the same name in the PlaceAutocompleteElement class.

PlacePredictionSelectEvent class

google.maps.places.PlacePredictionSelectEvent class

This event is created after the user selects a prediction item with the PlaceAutocompleteElement. Access the selection with event.placePrediction.

Convert placePrediction to a Place by calling PlacePrediction.toPlace.

This class extends Event.

Access by calling const {PlacePredictionSelectEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceAutocompleteRequestErrorEvent class

google.maps.places.PlaceAutocompleteRequestErrorEvent class

This event is emitted by the PlaceAutocompleteElement when there is an issue with the network request.

This class extends Event.

Access by calling const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceContextualElement class

google.maps.places.PlaceContextualElement class

A widget that uses the context token to display a contextual view of the Grounding with Google Maps response.

Custom element:
<gmp-place-contextual context-token="string"></gmp-place-contextual>

This class extends HTMLElement.

This class implements PlaceContextualElementOptions.

Access by calling const {PlaceContextualElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceContextualElementOptions interface

google.maps.places.PlaceContextualElementOptions interface

Options for PlaceContextualElement.

PlaceContextualListConfigElement class

google.maps.places.PlaceContextualListConfigElement class

An HTML element that configures options for the Place Contextual Element's list view.

Custom element:
<gmp-place-contextual-list-config layout="compact" map-hidden></gmp-place-contextual-list-config>

This class extends HTMLElement.

This class implements PlaceContextualListConfigElementOptions.

Access by calling const {PlaceContextualListConfigElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceContextualListConfigElementOptions interface

google.maps.places.PlaceContextualListConfigElementOptions interface

Options for PlaceContextualListConfigElement.

PlaceContextualListLayout constants

google.maps.places.PlaceContextualListLayout constants

The list of layouts that the Place Contextual Element supports for the list view.

Access by calling const {PlaceContextualListLayout} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceDetailsElement class

google.maps.places.PlaceDetailsElement class

Displays details for a place in a full layout. Append either a PlaceDetailsPlaceRequestElement or PlaceDetailsLocationRequestElement to specify the place to be rendered. Append a PlaceContentConfigElement, PlaceStandardContentElement, or PlaceAllContentElement to specify which content to render.

Example:

 <gmp-place-details>
   <gmp-place-details-place-request
     place="PLACE_ID"
   ></gmp-place-details-place-request>
   <gmp-place-content-config>
     <gmp-place-media lightbox-preferred></gmp-place-media>
   </gmp-place-content-config>
 </gmp-place-details> 

Custom element:
<gmp-place-details></gmp-place-details>

This class extends HTMLElement.

This class implements PlaceDetailsElementOptions.

Access by calling const {PlaceDetailsElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceDetailsElementOptions interface

google.maps.places.PlaceDetailsElementOptions interface

Options for PlaceDetailsElement.

PlaceDetailsCompactElement class

google.maps.places.PlaceDetailsCompactElement class

Displays details for a place in a compact layout. Append a PlaceDetailsPlaceRequestElement or PlaceDetailsLocationRequestElement to specify the place to be rendered. Append a PlaceContentConfigElement, PlaceStandardContentElement, or PlaceAllContentElement to specify which content to render.

Example:

 <gmp-place-details-compact>
   <gmp-place-details-place-request
     place="PLACE_ID"
   ></gmp-place-details-place-request>
   <gmp-place-content-config>
     <gmp-place-media lightbox-preferred></gmp-place-media>
   </gmp-place-content-config>
 </gmp-place-details-compact> 

Custom element:
<gmp-place-details-compact orientation="vertical" truncation-preferred></gmp-place-details-compact>

This class extends HTMLElement.

This class implements PlaceDetailsCompactElementOptions.

Access by calling const {PlaceDetailsCompactElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceDetailsCompactElementOptions interface

google.maps.places.PlaceDetailsCompactElementOptions interface

Options for PlaceDetailsCompactElement.

PlaceDetailsOrientation constants

google.maps.places.PlaceDetailsOrientation constants

Orientation variants for PlaceDetailsCompactElement.

Access by calling const {PlaceDetailsOrientation} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

PlaceDetailsPlaceRequestElement class

google.maps.places.PlaceDetailsPlaceRequestElement class

Configures a PlaceDetailsCompactElement or PlaceDetailsElement to load data based on a place object, ID, or resource name. Append this element as a child of a PlaceDetailsCompactElement or PlaceDetailsElement to load data for the specified place. For example:

 <gmp-place-details>
   <gmp-place-details-place-request
     place="PLACE_ID"
   ></gmp-place-details-place-request>
 </gmp-place-details> 

Custom element:
<gmp-place-details-place-request place="some-place-id"></gmp-place-details-place-request>

This class extends HTMLElement.

This class implements PlaceDetailsPlaceRequestElementOptions.

Access by calling const {PlaceDetailsPlaceRequestElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceDetailsPlaceRequestElementOptions interface

google.maps.places.PlaceDetailsPlaceRequestElementOptions interface

Options for PlaceDetailsPlaceRequestElement.

PlaceDetailsLocationRequestElement class

google.maps.places.PlaceDetailsLocationRequestElement class

Configures a PlaceDetailsCompactElement or PlaceDetailsElement to load data based on a location. Append this element as a child of a PlaceDetailsCompactElement or PlaceDetailsElement to load data for the specified location. For example:

 <gmp-place-details>
   <gmp-place-details-location-request
     location="37.6207665,-122.4284806"
   ></gmp-place-details-location-request>
 </gmp-place-details> 

Custom element:
<gmp-place-details-location-request location="lat,lng"></gmp-place-details-location-request>

This class extends HTMLElement.

This class implements PlaceDetailsLocationRequestElementOptions.

Access by calling const {PlaceDetailsLocationRequestElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceDetailsLocationRequestElementOptions interface

google.maps.places.PlaceDetailsLocationRequestElementOptions interface

Options for PlaceDetailsLocationRequestElement.

PlaceContentConfigElement class

google.maps.places.PlaceContentConfigElement class

Configures a PlaceDetailsCompactElement or PlaceDetailsElement to show a custom set of content. Append this element as a child to use it.

For PlaceDetailsCompactElement or PlaceDetailsElement, append any of the following elements to the PlaceContentConfigElement to show the corresponding content:
PlaceAddressElement, PlaceAccessibleEntranceIconElement, PlaceAttributionElement PlaceMediaElement, PlaceOpenNowStatusElement, PlacePriceElement, PlaceRatingElement, PlaceTypeElement.

Specific to PlaceDetailsElement, you may also append any of the following elements:
PlaceFeatureListElement PlaceOpeningHoursElement, PlacePhoneNumberElement, PlacePlusCodeElement, PlaceReviewsElement, PlaceSummaryElement, PlaceTypeSpecificHighlightsElement, PlaceWebsiteElement.

The order of the children does not matter; the element renders content in a standard order which is not customizable. Example:

 <gmp-place-details>
   <gmp-place-content-config>
     <gmp-place-media lightbox-preferred></gmp-place-media>
     <gmp-place-address></gmp-place-address>
   </gmp-place-content-config>
 </gmp-place-details> 

Custom element:
<gmp-place-content-config></gmp-place-content-config>

This class extends HTMLElement.

This class implements PlaceContentConfigElementOptions.

Access by calling const {PlaceContentConfigElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceContentConfigElementOptions interface

google.maps.places.PlaceContentConfigElementOptions interface

Options for PlaceContentConfigElement.

PlaceListElement class

google.maps.places.PlaceListElement class

An HTML element that displays the results of a place search in a list. Use the configureFromSearchByTextRequest() or configureFromSearchNearbyRequest() methods to specify the request to render results for. To use the Place List Element, enable the Places UI Kit API for your project in the Google Cloud console.

Custom element:
<gmp-place-list selectable></gmp-place-list>

This class extends HTMLElement.

This class implements PlaceListElementOptions.

Access by calling const {PlaceListElement} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Methods
addEventListener	addEventListener(type, listener[, options]) Parameters:  type:  string A case-sensitive string representing the event type to listen for. listener:  EventListener|EventListenerObject The object that receives a notification. This must be a function or an object with the handleEvent method options:  boolean|AddEventListenerOptions optional See options. Custom events only support capture and passive. Return Value:  void Sets up a function that will be called whenever the specified event is delivered to the target. See addEventListener.
configureFromSearchByTextRequest	configureFromSearchByTextRequest(request) Parameters:  request:  SearchByTextRequest The request to render results for. The fields property of the SearchByTextRequest is not required. Return Value:  Promise<void> A promise that resolves once place data is loaded and rendered. Configures the widget to render search results from a Places Text Search API request.
configureFromSearchNearbyRequest	configureFromSearchNearbyRequest(request) Parameters:  request:  SearchNearbyRequest The request to render results for. The fields property of the SearchNearbyRequest is not required. Return Value:  Promise<void> A promise that resolves once place data is loaded and rendered. Configures the widget to render search results from a Places Nearby Search API request.
removeEventListener	removeEventListener(type, listener[, options]) Parameters:  type:  string A string which specifies the type of event for which to remove an event listener. listener:  EventListener|EventListenerObject The event listener of the event handler to remove from the event target. options:  boolean|EventListenerOptions optional See options. Return Value:  void Removes an event listener previously registered with addEventListener from the target. See removeEventListener.

PlaceListElementOptions interface

google.maps.places.PlaceListElementOptions interface

Options for PlaceListElement.

PlaceListPlaceSelectEvent class

google.maps.places.PlaceListPlaceSelectEvent class

This event is emitted by the PlaceListElement when the user selects a place.

This class extends Event.

Access by calling const {PlaceListPlaceSelectEvent} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

Autocomplete class

google.maps.places.Autocomplete class

A widget that provides Place predictions based on a user's text input. It attaches to an input element of type text, and listens for text entry in that field. The list of predictions is presented as a drop-down list, and is updated as text is entered.

This class extends MVCObject.

Access by calling const {Autocomplete} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

AutocompleteOptions interface

google.maps.places.AutocompleteOptions interface

The options that can be set on an Autocomplete object.

SearchBox class

google.maps.places.SearchBox class

A widget that provides query predictions based on a user's text input. It attaches to an input element of type text, and listens for text entry in that field. The list of predictions is presented as a drop-down list, and is updated as text is entered.

This class extends MVCObject.

Access by calling const {SearchBox} = await google.maps.importLibrary("places").
See Libraries in the Maps JavaScript API.

SearchBoxOptions interface

google.maps.places.SearchBoxOptions interface

The options that can be set on a SearchBox object.