Salesforce Console Developer Guide
jNote: 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.
Lightning Console 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 that can be used from Aura components to interact with the console’s navigation menu. This API is used in Lightning console apps only.
- The utility bar API provides methods that can be used from Aura components and Lightning web components in the utility bar to open, resize, or minimize a utility. This API is used in Lightning apps with standard or console navigation.
- The workspace API provides methods for Aura components and Lightning web components for opening, closing, and getting information about workspace tabs and subtabs. This API is used in Lightning console apps only.
For a full list of methods in each API, see Methods for Lightning Console JavaScript API.
You can build Lightning components using two programming models: the Lightning Web Components model and Aura Components model. Although both models can coexist and interoperate on a page, we recommend that you build your apps with Lightning Web Components, which use HTML and modern JavaScript.