Salesforce Console Developer Guide

What Is the Console Developer Guide?
Why Your UI Matters
Lightning Console JavaScript API for Lightning Experience
Get to Know the Lightning Console
Get to Know the Utility Bar
Lightning Console JavaScript API Syntax
Using Events in Lightning Console Apps
Using Page Context in the Utility Bar API
Debugging
Salesforce Console Integration Toolkit for Salesforce Classic
Methods for Salesforce Classic
Methods for Lightning Experience
Events for Lightning Experience
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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: 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 navigation and Lightning console apps, 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.