For the complete documentation index, see llms.txt. This page is also available as Markdown.

Control Console Tab

The Control Console Tab interaction manages a Lightning Console tab or subtab — closing, focusing, refreshing, relabelling, or highlighting it.

Overview

The Control Console Tab interaction lets you manage the user's Lightning Console workspace directly from a component. Use it to close, focus, or refresh a console tab or subtab, apply or remove a custom label, icon, or highlight, and enable or disable the tab's close button.


Configuration

Action

The console tab action to execute. Choose what you want to do to the current tab, or to a specific tab if a Tab Id is provided.

Action
Description

Close

Closes the tab.

Focus

Brings the tab into focus.

Focus Next

Moves the focus to the next tab.

Focus Previous

Moves the focus to the previous tab.

Refresh

Refreshes the tab's content.

Set Label

Applies a custom label to the tab.

Set Icon

Applies a custom icon to the tab.

Set Highlight

Applies a colored highlight to the tab.

Remove Label

Removes the custom label from the tab.

Remove Icon

Removes the custom icon from the tab.

Remove Highlight

Removes the highlight from the tab.

Disable Close

Prevents the user from closing the tab.

Enable Close

Allows the user to close the tab again.

Tab Id

Optional tab id to target. If omitted, the action applies to the current tab.

Action-specific settings

Depending on the selected action, additional settings become available:

  • Include Subtabs (Refresh): When refreshing a workspace tab, also refresh all subtabs inside that workspace.

  • Label (Set Label): The custom label to apply to the tab.

  • Icon Name (Set Icon): The icon to apply to the tab.

  • Icon Alternative Text (Set Icon): Optional accessible alternative text for the custom tab icon.

  • Highlight State (Set Highlight): The highlight color state to apply to the tab. Choose between Success, Error and Warning.

  • Highlight Pulse (Set Highlight): If enabled, makes the tab highlight pulse — smoothly alternating colors — to draw the user's attention.


Example

Imagine a service console where agents complete a case intake using a screen flow. When the flow finishes, a Control Console Tab interaction can rename the tab to reflect the case status, apply a success highlight, or simply close the tab so the agent can move on to the next case — all without any manual tab management.

Last updated

Was this helpful?