The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Configure a Component for Lightning Console App

To use a Lightning web component as a navigation item in a custom console app, define the component’s metadata.

The componentName.js-meta.xml file defines the metadata values for the component. To make your component available as a navigation item, set isExposed to true, and define a lightning__AppPage target.

After configuring the component, you can create or edit a custom console app and add your component as a navigation item.

To work with workspace tabs and subtabs programmatically, use the Lightning Console JavaScript API.

The lwc-recipes repo has examples of working with workspace tabs. Look for components that start with workspace, such as workspaceAPIFocusTab.

See Also