Salesforce Console Developer Guide
jNewer Version Available
setTabHighlighted() for Lightning Experience
Highlights the specified tab with a different background color and a badge. When you
close and reopen a Lightning console app it remembers your open workspace tabs and subtabs, but it
does not remember whether a tab was highlighted. This method works only in
Lightning console apps.
Arguments
| Name | Type | Description |
|---|---|---|
| tabId | string | The ID of the tab to be highlighted. |
| highlighted | boolean | Whether the tab is highlighted. Makes a utility more prominent by giving it a different background color. |
| options | object | Optional. Additional options that modify the appearance of the
highlighted tab. Available options are:
|
Sample Code
This component has a button that, when pressed, sets the focused tab as highlighted.
Component code:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <force:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Set Focused Tab Highlighted" onclick="{! c.setFocusedTabHighlighted }" />
4 </aura:component>Controller code:
1({
2 setFocusedTabHighlighted : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.getFocusedTabInfo().then(function(response) {
5 var focusedTabId = response.tabId;
6 workspaceAPI.setTabHighlighted({
7 tabId: focusedTabId,
8 highlighted: true,
9 options: {
10 pulse: true
11 }
12 });
13 })
14 .catch(function(error) {
15 console.log(error);
16 });
17 }
18})Response
This method returns a promise that, upon success, returns a
tabInfo object representing the modified tab. A
tabInfo object is a JSON array of
information about a workspace tab, with nested arrays of information on each subtab.
This is the structure of a tabInfo
object.
1{ tabId: string,
2 active: boolean,
3 pinned: boolean,
4 closeable: boolean,
5 highlighted: boolean,
6 title: string,
7 icon: string (SLDS iconKey),
8 iconAlt: string,
9 recordId: string,
10 url: string (URL),
11 pageReference: object,
12 subtabs: [
13 {
14 tabId: string,
15 active: boolean,
16 pinned: boolean,
17 closeable: boolean,
18 highlighted: boolean,
19 title: string,
20 icon: string (SLDS iconKey),
21 iconAlt: string,
22 recordId: string,
23 url: string (URL),
24 pageReference: object,
25 isSubtab: boolean,
26 parentTabId: string,
27 customTitle: string,
28 customIcon: string (URL),
29 customIconAlt: string
30 },
31 { ... }
32 ],
33 isSubtab: boolean,
34 parentTabId: string,
35 customTitle: string,
36 customIcon: string (URL),
37 customIconAlt: string
38}