Lightning Console API

Lightning console apps allow users to quickly find the information they need, and make edits while viewing multiple records on one screen. The Lightning Console JavaScript API gives you programmatic access to Lightning console apps, so you can fully integrate Lightning console apps with Aura components and extend them to meet your business needs.

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.

As of Spring ’19 (API version 45.0), you can build Lightning components using two programming models: the Lightning Web Components model, and the original Aura Components model. Lightning web components are custom HTML elements built using HTML and modern JavaScript. Lightning web components and Aura components can coexist and interoperate on a page. This developer guide covers Aura components only.

Note

Salesforce Console Developer Guide

Lightning Console API