Salesforce Dictionary - Free Salesforce GlossarySalesforce Dictionary
Full Custom Console Component entry
How-to guide

How to add a Custom Console Component to a console app

Here is the common path: add an existing Lightning component to a console app as a Custom Console Component, either on the page or in the utility bar. This assumes the component is already built and exposed with the right target.

By Dipojjal Chakrabarti · Founder & Editor, Salesforce DictionaryLast updated Jun 16, 2026

Here is the common path: add an existing Lightning component to a console app as a Custom Console Component, either on the page or in the utility bar. This assumes the component is already built and exposed with the right target.

  1. Expose the component for the console

    In the component js-meta.xml file, set isExposed to true and add the target you need: lightning__AppPage to place it on a console page, or lightning__UtilityBar to add it to the utility bar. Add design properties under targetConfigs if admins should configure it.

  2. Open the console app in Setup

    Go to Setup, then App Manager. Find your Lightning console app and choose Edit. This opens the app in the Lightning Experience App Manager where both the pages and the utility bar are configured.

  3. Place it on a page or in the utility bar

    For a page region, edit the relevant console Lightning page in the Lightning App Builder and drag your component into a sidebar, the main region, or the highlights area. For the utility bar, open the Utility Bar Items section, add a utility, and select your component.

  4. Set properties and save

    Fill in any exposed design properties, set the utility label and icon if it is a utility, then save. For a page, activate it and assign it to the app and the right profiles or app contexts.

  5. Verify in the running console

    Open the console app as an agent would, navigate to a record, and confirm the component renders, reads the active record, and responds when you move between tabs.

Key options
lightning__AppPage targetremember

Lets the component be dropped onto a console Lightning page region, such as a sidebar or the main area, or used as a navigation item.

lightning__UtilityBar targetremember

Lets the component be added to the app utility bar as a docked panel tool, hidden until the agent clicks its icon.

targetConfigs design propertiesremember

Expose inputs that an admin can fill in from App Manager, so one component can be reused with different configuration and no code change.

Custom SVG iconremember

Add a single SVG file named for the component to give a utility-bar item a custom icon; only one SVG is allowed per component folder.

Gotchas
  • The utility bar does not support Visualforce pages or components. A footer tool must be a Lightning component.
  • A utility bar built through the App Manager wizard can be assigned to only one app; assigning the same bar to several apps needs the Metadata API.
  • Keep the utility bar short. Salesforce recommends no more than about ten utilities with brief labels so agents can scan it quickly.
  • Use the Lightning Console JavaScript API for new components, not the Classic sforce.console toolkit, which is kept working only for migration.

See the full Custom Console Component entry

Custom Console Component includes the definition, worked example, deep dive, related terms, and a quiz.