Salesforce Console Developer Guide
jNewer Version Available
Lightning Console JavaScript API
| Available in: Lightning Experience |
| Available in: Essentials, Professional, Enterprise,
Performance, Unlimited, and Developer Editions Lightning console apps are available for an extra cost to users with Salesforce Platform user licenses for certain products. Some restrictions apply. For pricing details, contact your Salesforce account executive. |
The Lightning Console JavaScript API includes three libraries, the navigation item API, the utility bar API, and the workspace API. The navigation item API provides methods for interacting with the console’s navigation menu. The utility bar API provides methods that can be used from Aura components in the utility bar to open, resize, or minimize a utility. The workspace API provides methods for opening, closing, and getting information about workspace tabs and subtabs. The utility bar API is used in Lightning apps with standard or console navigation, while the navigation item API and workspace API are used only in Lightning console apps.
For a full list of methods in each API, see Methods for Lightning Console JavaScript API.
-
Lightning Console JavaScript API Syntax
Use Lightning Console JavaScript API methods in the JavaScript controller of an Aura component. -
Using Background Utility Items
Implement the lightning:backgroundUtilityItem interface to create a component that fires and responds to events without rendering in the utility bar. -
Using Pop-Out Utilities
Utilities that support pop-out can be “popped out” of the utility bar and into their own separate child windows. To pop a utility out, click the
icon. From there, you can pop the utility back into the utility bar with the 
icon, or close the utility. Pop-out utilities are the Lightning equivalent to multi-monitor components in Classic. -
Using Events with the Lightning Console JavaScript API
The Lightning framework uses event-driven programming, which allows you to create handlers to respond to interface events as they occur. The Lightning Console JavaScript API provides several events specific to Lightning console apps. -
Using Page Context in the Utility Bar API
In both Lightning console apps and standard navigation apps, utilities can respond to the context of the current page. Set implements="force:hasRecordId" on an Aura component used in the utility bar to access the recordId of the record a user is viewing. -
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. -
Debugging
Use your browser’s console and JavaScript error messages generated within Salesforce to debug Lightning pages built with the Lightning Console JavaScript API. The methods in the Lightning Console JavaScript APIs are asynchronous and return their results using promises. -
Methods for Lightning Console JavaScript API
If your org is using Lightning Experience, use Lightning Console JavaScript API methods. -
Events for Lightning Console JavaScript API
Use events and handlers in your Aura components and controllers to respond to events like workspace tabs opening, closing, or gaining focus.