Lightning Console JavaScript API for Lightning Experience

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 the Lightning framework 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 two libraries, the utility bar API and the workspace API. The utility bar API provides methods that can be used from Lightning 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 can be used in Lightning apps with standard or console navigation, while the workspace API can be used in Lightning console apps only.

For a full list of methods in each API, see the reference section of this guide.

Salesforce Console Developer Guide

Lightning Console JavaScript API for Lightning Experience

See Also