Formatted Address

lightning-formatted-address

Displays a formatted address with a link to the given location on Google Maps. The link is opened in a new tab. A static map can be displayed with the address for better context.

For Use In

Lightning Experience, Experience Builder Sites, Salesforce Mobile App, Lightning Out (Beta), Standalone Lightning App

A lightning-formatted-address component displays addresses in a format and field order that's determined by the user's Salesforce locale.

Specify a valid address using attributes for street, city, country, province, and postal-code.

This example displays an address.

The output looks like this in the en-US locale.

1 Market St.
San Francisco, CA 94105
US

By default, the address is displayed as a link that opens the given location in Google Maps in a new tab. The link follows the format https://www.google.com/maps/?q=your+address. In the example, the link would be https://www.google.com/maps/?q=121%20Spear%20St.%0ASan%20Francisco,%20CA%2094105%0AUS.

Specify the disabled attribute to display the address in plain text without a link.

You can provide the latitude and longitude attributes in addition to the address fields. This enables faster map rendering by avoiding the geocode processing that's required for street addresses on Google Maps. The formatted address displays the street address fields, but the link URL uses the latitude and longitude for Google Maps.

This example displays an address and uses latitude and longitude for mapping.

The link URL with latitude and longitude follows the format https://www.google.com/maps/?q=37.792179,-122.392735.

Use the show-static-map attribute to display a map with your address. The address and the static map are both linked to Google Maps.

By default, the slds-truncate class is assigned to each line of the address. To remove address line truncation, set variant="plain". This will render each address line without truncating it.