Salesforce Console Developer Guide

Salesforce Console Developer Guide
How are the Classic and Lightning APIs Different?
Lightning Experience API
Get to Know the Lightning Console
Get to Know the Utility Bar
Lightning Console JavaScript API Syntax
Using Background Utility Items
Using Pop-Out Utilities
Using Events in Lightning Console Apps
Using Page Context in the Utility Bar API
Using Page References to Open Console Workspace Tabs and Subtabs
Debugging
Methods for Lightning Experience
Events for Lightning Experience
Salesforce Classic API
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Using Page References to Open Console Workspace Tabs and Subtabs

Use openTab() and openSubtab() with a lightning:isUrlAddressible component to open custom Aura components in Lightning console apps.
lightning:isUrlAddressable provides the following benefits over force:navigateToComponent for console apps:
  • Future-proofs your apps from changes in URL formats.
  • Generates a user-friendly URL for your tabs.
  • Opens an Aura component as a subtab, even if called from a utility, a hover, or another page.
  • Allows a mechanism to conditionally open a given component more than once or redirect to an already open workspace or subtab using the uid parameter.
To create a page reference we can use to open workspace tabs and subtabs, let’s create greetings.cmp, and implement lightning:isUrlAddressible. This component displays “Hello, <name>” where a URL parameter, c__name, provides the name when the component is opened. The component also defines a pageReference that we can use to navigate to it.
The JavaScript controller greetingsController.js handles URL parameters in the init method and assigns the name attribute using that URL parameter.
Now let’s create openGreetings.cmp, which includes an input field to set the c__name URL parameter when we open greetings.cmp.

The controller openGreetingsController.js uses openSubtab() and sets c__name to the value of the myname input field. You can use the uid parameter to conditionally dedupe tabs and subtabs. Omit the uid to open a new tab or subtab every time.

Now that we have everything set up, we can test our components by creating a custom tab in Setup for openGreetings.cmp. Add the custom tab to a console app and open the console app. Select the custom tab from the nav menu to open openGreetings.cmp. Enter a name and click “Open Geeting in Subtab.” greetings.cmp opens as a subtab and displays its greeting with the provided name.