Skip to content

Add the AddressTools Component to a Lightning Record Page

Overview

The AddressTools component is a widget you add to a Lightning Record Page to bring everything address-related on that record into one place. It builds on top of your existing page rather than replacing any part of it, and gives your users quick access to:

  • Quick address edit
  • Local time
  • Type-ahead PowerSearch address verification
  • Address status
  • ZIP Code Lookup
  • Country and State suggestion picklists
  • QuickComplete Country default country selection

The interactive AddressTools functionality cannot run on the standard Record Detail component that Salesforce provides in Lightning, so we recommend adding this component wherever your users need to edit an address on an existing record. Type-ahead PowerSearch is available only through the AddressTools components, this one and the AddressTools Override. See Enable AddressTools Override for New Records.

Note: The Lightning Web Component version of this component requires AddressTools v10.6 or later. On earlier versions only the Aura component is available. See Earlier Versions below.

Before You Start

The address block you want to display must already exist, as the component is configured against it. If you have not created one yet, see Binding an Address Block.

Your other setup steps should also be complete, with the settings and triggers turned on for the features you want the component to surface.

Step 1: Open the Lightning Record Page

  1. Navigate to Setup > Object Manager.
  2. Select the object, then select Lightning Record Pages.
  3. Click Edit beside an existing page, or click New to create one.

Note: You can also get there from the record itself. Open a record of that object, click the setup gear, and select Edit Page to open the page it is using in Lightning App Builder.

Step 2: Add the Component

  1. In the components list, find AddressTools Component (LWC) under Custom - Managed.
  2. Drag it onto the page where you want the address to appear.

Note: Two components have near-identical names in the list. AddressTools Component (LWC) is the current one we recommend using. AddressTools Component (Aura) is the older component from versions before v10.6, this can be ignored if you have added the LWC.

Step 3: Configure the Component

With the component selected, set its properties in the panel on the right.

  1. Choose the Address block to display. This is required.
  2. Optionally, enter a Component header title to replace the default heading.

Note: To show more than one address on a page, such as a billing and a shipping address, add the component multiple times and assign a different address block to each.

Step 4: Save Your Changes

Click Save to keep the component on the page.

If you created a new page rather than editing an existing one, Salesforce will prompt you to activate it and choose how it is assigned before your users see it. Pages you edited stay assigned as they were, so there is nothing further to do.

Earlier Versions

The Lightning Web Component arrived in AddressTools v10.6. If your org is on an earlier version, AddressTools Component (Aura) is the only option, and the steps above are otherwise the same.

We recommend you use the AddressTools Component (LWC) by upgrading to v10.6 or later from AgentExchange (formerly AppExchange). Any page still using the Aura component will continue to work and upgrading will not swap the component automatically, so you will then need to replace it by hand to move across to the LWC. For the differences between the two and the steps to swap a page over, see Switching to the LWC AddressTools Component.