Salesforce Docs Portal

Tab Updated

lightning:tabUpdated

Fires when a Console workspace or subtab has been updated, such as when a label, icon, or content changes.

For Use In

Lightning Experience

::::::tabset{tabs='[ "Develop", "Specifications"]'}

:::::tab

lightning:tabUpdated is an application event that indicates a tab has been updated successfully. This event is supported in Lightning console apps only.

Handle the event using aura:handler.

<aura:component implements="flexipage:availableForAllPageTypes" access="global">
  <lightning:workspaceAPI aura:id="workspace" />
  <aura:handler event="lightning:tabUpdated" action="{! c.onTabUpdated }" />
</aura:component>

In your client-side controller, retrieve the ID of the updated tab.

({
  onTabUpdated: function (component, event, helper) {
    var updatedTabId = event.getParam("tabId");
    console.log(updatedTabId);
  },
});

For more information, see the Salesforce Console Developer Guide.

:::::

:::::tab

Attributes

Name Description Type Default Required
tabId The ID of the tab that was updated. string Yes

:::::

::::::