PlaceContentConfigElement class
class
google.maps.places.PlaceContentConfigElement
extends HTMLElement
implements PlaceContentConfigElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement or PlaceSearchElement to show a custom set of content. Append this element as a child to use it.
For PlaceDetailsCompactElement, PlaceDetailsElement or PlaceSearchElement, 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, PlaceReviewSummaryElement, 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> <gmp-place-content-config></gmp-place-content-config>
const {PlaceContentConfigElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceContentConfigElement |
PlaceContentConfigElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceContentConfigElementOptions interface
interface
google.maps.places.PlaceContentConfigElementOptions
implemented by PlaceContentConfigElement
Options for PlaceContentConfigElement.
PlaceAllContentElement class
class
google.maps.places.PlaceAllContentElement
extends HTMLElement
implements PlaceAllContentElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show all available content. Append this element as a child to use it. For example:
<gmp-place-details>
<gmp-place-all-content></gmp-place-all-content>
</gmp-place-details>
<gmp-place-all-content></gmp-place-all-content>
const {PlaceAllContentElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceAllContentElement |
PlaceAllContentElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceAllContentElementOptions interface
interface
google.maps.places.PlaceAllContentElementOptions
implemented by PlaceAllContentElement
Options for PlaceAllContentElement.
PlaceStandardContentElement class
class
google.maps.places.PlaceStandardContentElement
extends HTMLElement
implements PlaceStandardContentElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a standard set of content. Append this element as a child to use it.
For PlaceDetailsElement, standard content consists of:
- media
- address
- rating
- type
- price
- accessible entrance icon
- website
- phone number
- opening hours
- summary
- type specific highlights
- reviews
- feature list
For
PlaceDetailsCompactElement, standard content consists of: - media
- rating
- type
- price
- accessible entrance icon
- open now status
For
PlaceSearchElement, standard content consists of: - media
- rating
- type
- price
- accessible entrance icon
For example:
<gmp-place-details>
<gmp-place-standard-content></gmp-place-standard-content>
</gmp-place-details>
<gmp-place-standard-content></gmp-place-standard-content>
const {PlaceStandardContentElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceStandardContentElement |
PlaceStandardContentElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceStandardContentElementOptions interface
interface
google.maps.places.PlaceStandardContentElementOptions
implemented by PlaceStandardContentElement
Options for PlaceStandardContentElement.
PlaceMediaElement class
class
google.maps.places.PlaceMediaElement
extends HTMLElement
implements PlaceMediaElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a place's media, such as photos. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-media lightbox-preferred></gmp-place-media>
</gmp-place-content-config>
<gmp-place-media lightbox-preferred preferred-size="value-name"> </gmp-place-media>
const {PlaceMediaElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceMediaElement |
PlaceMediaElement([options])Parameters:
|
Properties | |
|---|---|
lightboxPreferred
attr: lightbox-preferred |
Input type:
boolean optionalOutput type: booleanDefault:
falseWhether to enable or disable the media lightbox, in cases where both options are supported.
HTML attribute: lightbox-preferred |
preferredSize
attr: preferred-size |
Default:
nullThe preferred media size in cases where multiple sizes are supported, such as the vertical
PlaceSearchElement. The vertical PlaceSearchElement will use MediaSize.SMALL by default if this is not specified.HTML attribute: preferred-size="value-name" |
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceMediaElementOptions interface
interface
google.maps.places.PlaceMediaElementOptions
implemented by PlaceMediaElement
Options for PlaceMediaElement.
Properties | |
|---|---|
lightboxPreferred
optional |
Type:
boolean optional |
preferredSize
optional |
Type:
MediaSize optional |
MediaSize constants
constants
google.maps.places.MediaSize
library "places"
The preferred media size in cases where multiple sizes are supported, such as the vertical PlaceSearchElement.
These constants are also usable as strings. In TypeScript, the string literals are defined by the MediaSizeString type.
const {MediaSize} = await google.maps.importLibrary("places");
Constants | |
|---|---|
LARGE |
Large media size. |
MEDIUM |
Medium media size. |
SMALL |
Small media size. |
PlaceAddressElement class
class
google.maps.places.PlaceAddressElement
extends HTMLElement
implements PlaceAddressElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a place's address. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-address></gmp-place-address>
</gmp-place-content-config>
<gmp-place-address></gmp-place-address>
const {PlaceAddressElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceAddressElement |
PlaceAddressElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceAddressElementOptions interface
interface
google.maps.places.PlaceAddressElementOptions
implemented by PlaceAddressElement
Options for PlaceAddressElement.
PlaceRatingElement class
class
google.maps.places.PlaceRatingElement
extends HTMLElement
implements PlaceRatingElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a place's rating. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-rating></gmp-place-rating>
</gmp-place-content-config>
<gmp-place-rating></gmp-place-rating>
const {PlaceRatingElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceRatingElement |
PlaceRatingElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceRatingElementOptions interface
interface
google.maps.places.PlaceRatingElementOptions
implemented by PlaceRatingElement
Options for PlaceRatingElement.
PlaceTypeElement class
class
google.maps.places.PlaceTypeElement
extends HTMLElement
implements PlaceTypeElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a place's type. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-type></gmp-place-type>
</gmp-place-content-config>
<gmp-place-type></gmp-place-type>
const {PlaceTypeElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceTypeElement |
PlaceTypeElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceTypeElementOptions interface
interface
google.maps.places.PlaceTypeElementOptions
implemented by PlaceTypeElement
Options for PlaceTypeElement.
PlacePriceElement class
class
google.maps.places.PlacePriceElement
extends HTMLElement
implements PlacePriceElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a place's price level or price range. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-price></gmp-place-price>
</gmp-place-content-config>
<gmp-place-price></gmp-place-price>
const {PlacePriceElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlacePriceElement |
PlacePriceElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlacePriceElementOptions interface
interface
google.maps.places.PlacePriceElementOptions
implemented by PlacePriceElement
Options for PlacePriceElement.
PlaceAccessibleEntranceIconElement class
class
google.maps.places.PlaceAccessibleEntranceIconElement
extends HTMLElement
implements PlaceAccessibleEntranceIconElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show a wheelchair icon if the place has an accessible entrance. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-accessible-entrance-icon></gmp-place-accessible-entrance-icon>
</gmp-place-content-config>
<gmp-place-accessible-entrance-icon></gmp-place-accessible-entrance-icon>
const {PlaceAccessibleEntranceIconElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceAccessibleEntranceIconElement |
PlaceAccessibleEntranceIconElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceAccessibleEntranceIconElementOptions interface
interface
google.maps.places.PlaceAccessibleEntranceIconElementOptions
implemented by PlaceAccessibleEntranceIconElement
Options for PlaceAccessibleEntranceIconElement.
PlaceOpenNowStatusElement class
class
google.maps.places.PlaceOpenNowStatusElement
extends HTMLElement
implements PlaceOpenNowStatusElementOptions
library "places"
Configures a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement to show the current open or closed status of a place. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-open-now-status></gmp-place-open-now-status>
</gmp-place-content-config>
<gmp-place-open-now-status></gmp-place-open-now-status>
const {PlaceOpenNowStatusElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceOpenNowStatusElement |
PlaceOpenNowStatusElement([options])Parameters:
|
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceOpenNowStatusElementOptions interface
interface
google.maps.places.PlaceOpenNowStatusElementOptions
implemented by PlaceOpenNowStatusElement
Options for PlaceOpenNowStatusElement.
PlaceReviewSummaryElement class
class
google.maps.places.PlaceReviewSummaryElement
extends HTMLElement
implements PlaceReviewSummaryElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's review summary. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-review-summary></gmp-place-review-summary>
</gmp-place-content-config>
<gmp-place-review-summary></gmp-place-review-summary>
const {PlaceReviewSummaryElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceReviewSummaryElementOptions interface
interface
google.maps.places.PlaceReviewSummaryElementOptions
implemented by PlaceReviewSummaryElement
Options for PlaceReviewSummaryElement.
PlaceReviewsElement class
class
google.maps.places.PlaceReviewsElement
extends HTMLElement
implements PlaceReviewsElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's reviews. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-reviews></gmp-place-reviews>
</gmp-place-content-config>
<gmp-place-reviews></gmp-place-reviews>
const {PlaceReviewsElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceReviewsElementOptions interface
interface
google.maps.places.PlaceReviewsElementOptions
implemented by PlaceReviewsElement
Options for PlaceReviewsElement.
PlaceSummaryElement class
class
google.maps.places.PlaceSummaryElement
extends HTMLElement
implements PlaceSummaryElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's summary. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-summary></gmp-place-summary>
</gmp-place-content-config>
<gmp-place-summary></gmp-place-summary>
const {PlaceSummaryElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceSummaryElementOptions interface
interface
google.maps.places.PlaceSummaryElementOptions
implemented by PlaceSummaryElement
Options for PlaceSummaryElement.
PlaceFeatureListElement class
class
google.maps.places.PlaceFeatureListElement
extends HTMLElement
implements PlaceFeatureListElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's feature list in the "About" tab. Feature list can include accessibility options, amenities, accepted payment methods, and more. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-feature-list></gmp-place-feature-list>
</gmp-place-content-config>
<gmp-place-feature-list></gmp-place-feature-list>
const {PlaceFeatureListElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceFeatureListElementOptions interface
interface
google.maps.places.PlaceFeatureListElementOptions
implemented by PlaceFeatureListElement
Options for PlaceFeatureListElement.
PlaceOpeningHoursElement class
class
google.maps.places.PlaceOpeningHoursElement
extends HTMLElement
implements PlaceOpeningHoursElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's opening hours. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-opening-hours></gmp-place-opening-hours>
</gmp-place-content-config>
<gmp-place-opening-hours></gmp-place-opening-hours>
const {PlaceOpeningHoursElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceOpeningHoursElementOptions interface
interface
google.maps.places.PlaceOpeningHoursElementOptions
implemented by PlaceOpeningHoursElement
Options for PlaceOpeningHoursElement.
PlacePhoneNumberElement class
class
google.maps.places.PlacePhoneNumberElement
extends HTMLElement
implements PlacePhoneNumberElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's phone number. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-phone-number></gmp-place-phone-number>
</gmp-place-content-config>
<gmp-place-phone-number></gmp-place-phone-number>
const {PlacePhoneNumberElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlacePhoneNumberElementOptions interface
interface
google.maps.places.PlacePhoneNumberElementOptions
implemented by PlacePhoneNumberElement
Options for PlacePhoneNumberElement.
PlacePlusCodeElement class
class
google.maps.places.PlacePlusCodeElement
extends HTMLElement
implements PlacePlusCodeElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's plus code. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-plus-code></gmp-place-plus-code>
</gmp-place-content-config>
<gmp-place-plus-code></gmp-place-plus-code>
const {PlacePlusCodeElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlacePlusCodeElementOptions interface
interface
google.maps.places.PlacePlusCodeElementOptions
implemented by PlacePlusCodeElement
Options for PlacePlusCodeElement.
PlaceTypeSpecificHighlightsElement class
class
google.maps.places.PlaceTypeSpecificHighlightsElement
extends HTMLElement
implements PlaceTypeSpecificHighlightsElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's type-specific highlights, such as gas prices and EV charger availability. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-type-specific-highlights></gmp-place-type-specific-highlights>
</gmp-place-content-config>
<gmp-place-type-specific-highlights></gmp-place-type-specific-highlights>
const {PlaceTypeSpecificHighlightsElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceTypeSpecificHighlightsElementOptions interface
interface
google.maps.places.PlaceTypeSpecificHighlightsElementOptions
implemented by PlaceTypeSpecificHighlightsElement
Options for PlaceTypeSpecificHighlightsElement.
PlaceWebsiteElement class
class
google.maps.places.PlaceWebsiteElement
extends HTMLElement
implements PlaceWebsiteElementOptions
library "places"
Configures a PlaceDetailsElement to show a place's website. Append this element as a child of a PlaceContentConfigElement to use it. For example:
<gmp-place-content-config>
<gmp-place-website></gmp-place-website>
</gmp-place-content-config>
<gmp-place-website></gmp-place-website>
const {PlaceWebsiteElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceWebsiteElementOptions interface
interface
google.maps.places.PlaceWebsiteElementOptions
implemented by PlaceWebsiteElement
Options for PlaceWebsiteElement.
PlaceAttributionElement class
class
google.maps.places.PlaceAttributionElement
extends HTMLElement
implements PlaceAttributionElementOptions
library "places"
Allows customization of the Google Maps attribution text in a PlaceDetailsCompactElement, PlaceDetailsElement, or PlaceSearchElement. Append this element as a child of a PlaceContentConfigElement to use it. If this element is omitted, attribution will still be shown with default colors. For example:
<gmp-place-content-config>
<gmp-place-attribution
light-scheme-color="black"
dark-scheme-color="white"
></gmp-place-attribution>
</gmp-place-content-config>
<gmp-place-attribution dark-scheme-color="value-name" light-scheme-color="value-name"> </gmp-place-attribution>
const {PlaceAttributionElement} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
PlaceAttributionElement |
PlaceAttributionElement([options])Parameters:
|
Properties | |
|---|---|
darkSchemeColor
attr: dark-scheme-color |
Default:
AttributionColor.WHITEThe color of the Google Maps attribution in dark mode.
HTML attribute: dark-scheme-color="value-name" |
lightSchemeColor
attr: light-scheme-color |
Default:
AttributionColor.GRAYThe color of the Google Maps attribution in light mode.
HTML attribute: light-scheme-color="value-name" |
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceAttributionElementOptions interface
interface
google.maps.places.PlaceAttributionElementOptions
implemented by PlaceAttributionElement
Options for PlaceAttributionElement.
Properties | |
|---|---|
darkSchemeColor
optional |
Type:
AttributionColor optional |
lightSchemeColor
optional |
Type:
AttributionColor optional |
AttributionColor constants
constants
google.maps.places.AttributionColor
library "places"
Color options for Google Maps attribution text. Attribution may be customized to use any of these colors.
These constants are also usable as strings. In TypeScript, the string literals are defined by the AttributionColorString type.
const {AttributionColor} = await google.maps.importLibrary("places");
Constants | |
|---|---|
BLACK |
Black attribution text. |
GRAY |
Gray attribution text. |
WHITE |
White attribution text. |
PlaceButtonElement class
class
google.maps.places.PlaceButtonElement
extends HTMLElement
implements PlaceButtonElementOptions
library "places"
Displays a button slotted into either the action-main slot or the action-corner slot. PlaceButtonElement has no default behavior. Attach an event listener to the element to define its behavior. By default the button will be shown in the action-main slot.
<gmp-place-button action-aria-label="string" label="string"> </gmp-place-button>
const {PlaceButtonElement} = await google.maps.importLibrary("places");
Properties | |
|---|---|
actionAriaLabel
attr: action-aria-label |
Type:
string optionalDefault:
undefinedThe ARIA label for the internal control. Icon-only controls should always have an aria-label to describe their purpose and behavior. Controls rendered in the corner do not show a label so an aria-label is recommended to be used instead of the label for corner controls.
HTML attribute: action-aria-label="string" |
label
attr: label |
Type:
string optionalDefault:
undefinedThe label to display in the control. For links with predefined action types, this attribute is ignored. Links and buttons rendered in the action-corner slot do not display a label. It's recommended to use the
action-aria-label attribute instead for corner controls.HTML attribute: label="string" |
Slots | |
|---|---|
icon-start |
A slot for icon content starting before the label. This is used for both main and corner action controls. When a control collapses to its corner state content in this slot is what renders. |
Parts | |
|---|---|
button |
A css part which targets the inner control element. |
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
Events | |
|---|---|
gmp-click |
function(event)Arguments:
Fired when the control is clicked. |
PlaceButtonElementOptions interface
interface
google.maps.places.PlaceButtonElementOptions
implemented by PlaceButtonElement
Options for PlaceButtonElement.
Properties | |
|---|---|
actionAriaLabel
optional |
Type:
string optionalThe ARIA label for the internal control. Icon-only controls should always have an aria-label to describe their purpose and behavior. Controls rendered in the corner do not show a label so an aria-label is recommended to be used instead of the label for corner controls. |
label
optional |
Type:
string optionalThe label to display in the control. For links with predefined action types, this attribute is ignored. Links and buttons rendered in the action-corner slot do not display a label. It's recommended to use the action-aria-label attribute instead for corner controls. |
PlaceLinkElement class
class
google.maps.places.PlaceLinkElement
extends HTMLElement
implements PlaceLinkElementOptions
library "places"
Displays a link slotted into either the action-main slot or the action-corner slot. By default the link will be shown in the action-main slot. Use the action attribute to specify the behavior of the link. Several action types are available to use listed in ActionLinkType. For a custom link, specify the custom action type and set the href and label attributes.
<gmp-place-link action="value-name" action-aria-label="string" href="string" label="string" target="string"> </gmp-place-link>
const {PlaceLinkElement} = await google.maps.importLibrary("places");
Properties | |
|---|---|
action
attr: action |
Type:
ActionLinkType optionalThe type of action to perform when the link is clicked. Determines the default label, icon and destination href of the link. Use the
custom type and specify the href attribute to set a destination manually.HTML attribute: action="value-name" |
actionAriaLabel
attr: action-aria-label |
Type:
string optionalDefault:
undefinedThe ARIA label for the internal control. Icon-only controls should always have an aria-label to describe their purpose and behavior. Controls rendered in the corner do not show a label so an aria-label is recommended to be used instead of the label for corner controls.
HTML attribute: action-aria-label="string" |
href
attr: href |
Type:
string optionalDefault:
undefinedThe URL to open when the link is clicked. This is only used when the
action attribute is set to custom.HTML attribute: href="string" |
label
attr: label |
Type:
string optionalDefault:
undefinedThe label to display in the control. For links with predefined action types, this attribute is ignored. Links and buttons rendered in the action-corner slot do not display a label. It's recommended to use the
action-aria-label attribute instead for corner controls.HTML attribute: label="string" |
target
attr: target |
Type:
string optionalDefault:
undefinedDetermines where the link opens. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target.
HTML attribute: target="string" |
Slots | |
|---|---|
icon-start |
A slot for icon content starting before the label. This is used for both main and corner action controls. When a control collapses to its corner state content in this slot is what renders. |
Parts | |
|---|---|
button |
A css part which targets the inner control element. |
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
Events | |
|---|---|
gmp-click |
function(event)Arguments:
Fired when the control is clicked. |
PlaceLinkElementOptions interface
interface
google.maps.places.PlaceLinkElementOptions
implemented by PlaceLinkElement
Options for PlaceLinkElement.
Properties | |
|---|---|
action
optional |
Type:
ActionLinkType optional |
actionAriaLabel
optional |
Type:
string optionalThe ARIA label for the internal control. Icon-only controls should always have an aria-label to describe their purpose and behavior. Controls rendered in the corner do not show a label so an aria-label is recommended to be used instead of the label for corner controls. |
href
optional |
Type:
string optional |
label
optional |
Type:
string optionalThe label to display in the control. For links with predefined action types, this attribute is ignored. Links and buttons rendered in the action-corner slot do not display a label. It's recommended to use the action-aria-label attribute instead for corner controls. |
target
optional |
Type:
string optional |
ActionLinkType constants
constants
google.maps.places.ActionLinkType
library "places"
The action taken by a PlaceLinkElement when clicked. Determines the icon, label and href destination.
These constants are also usable as strings. In TypeScript, the string literals are defined by the ActionLinkTypeString type.
const {ActionLinkType} = await google.maps.importLibrary("places");
Constants | |
|---|---|
CALL |
Triggers a tel: link to call the place. Behavior is operating system dependent. |
CUSTOM |
Use this action type for custom links. When using this action type, the href attribute must be set on the PlaceLinkElement. |
OPEN_DIRECTIONS |
Opens directions to the place in the location specified by PlaceLinkElement.target. |
OPEN_MAP |
Opens the map in the location specified by PlaceLinkElement.target. |
OPEN_WEBSITE |
Opens the place's website in the location specified by PlaceLinkElement.target. |
ActionButtonPosition constants
constants
google.maps.places.ActionButtonPosition
library "places"
The slotted position of the control in the place details widget.
These constants are also usable as strings. In TypeScript, the string literals are defined by the ActionButtonPositionString type.
const {ActionButtonPosition} = await google.maps.importLibrary("places");
Constants | |
|---|---|
ACTION_CORNER |
The control is rendered in the corner of the widget. Corner controls render only an icon. |
ACTION_MAIN |
The control is rendered in the main content area of the widget. Labels and icons are rendered. |
PlaceActionEvent class
class
google.maps.places.PlaceActionEvent
extends Event
library "places"
The event fired when the action button is clicked.
const {PlaceActionEvent} = await google.maps.importLibrary("places");
Properties | |
|---|---|
place
readonly |
Type:
PlaceThe place that was clicked. |
PlaceNameElement class
class
google.maps.places.PlaceNameElement
extends HTMLElement
implements PlaceNameElementOptions
library "places"
Displays the name of a place within a place details element.
<gmp-place-name></gmp-place-name>
const {PlaceNameElement} = await google.maps.importLibrary("places");
Methods | |
|---|---|
Inherited:
addEventListener,
removeEventListener
|
PlaceNameElementOptions interface
interface
google.maps.places.PlaceNameElementOptions
implemented by PlaceNameElement
Options for PlaceNameElement.