Salesforce Console Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Lightning Console JavaScript 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 Lightning web components while extending 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 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.