Salesforce Console Developer Guide

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

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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 The pop-out icon icon. From there, you can pop the utility back into the utility bar with the The pop-in icon icon, or close the utility. Pop-out utilities are the Lightning equivalent to multi-monitor components in Classic.

Popping-out docked utility bar items isn't supported in Lightning Experience on iPad Safari.

Note

Standard Utilities

Pop-out is supported for these standard utilities. Standard utilities are utilities that are included with Salesforce.

  • Open CTI Softphone
  • History
  • Rich Text
  • Report Chart
  • Visualforce
  • Flow
  • List View
  • Recent Items
  • Chatter Feed
  • Chatter Publisher
  • Notes

Custom Utilities

Pop-out is available for custom utilities. To enable pop-out for custom utilities, activate the Utility Bar: Enable Pop-Out for Custom Utilities critical update. The critical update enables pop-out for all utilities in the “Custom” and “Custom – Managed” categories. Test your custom utilities in a sandbox environment before you enable the update.

Disabling Pop-Out

If you don’t want your custom utility to be popped out, you can disable pop-out in two ways.

Disabling Pop-Out within the Component

Use the lightning:utilityItem interface in your component and set the supportsPopOut attribute to false to disable pop-out.

1<aura:component implements="lightning:utilityItem">
2    <aura:attribute name="supportsPopOut" type="Boolean" default="false" />
3</aura:component>

Disabling pop-out within the component itself is a useful and simple way to ensure that the component can never be popped out.

Disabling Pop-Out with the Lightning Console JavaScript API

Use the disableUtilityPopOut() method and set the disabled argument to true to disable utility pop-out.

If you’re migrating from a Classic console app and using a Visualforce page for your utility, we automatically respect if setCustomConsoleComponentPopoutable is set to false.

Disabling pop-out with the Lightning Console JavaScript API allows you to enable and disable pop-out in real time.