closeTab() for Lightning Experience

Closes a workspace tab or subtab. This method works only in Lightning console apps.

Arguments

The method provides the same argument for both Aura Components and Lightning Web Components (LWC).

Name	Type	Description
`tabId`	string	ID of the workspace tab or subtab to close.

LWC Sample Code

This component checks if it’s in a Lightning console app using the isConsoleNavigation wire adapter. When the getFocusedTabInfo() resolves successfully, it returns the tabInfo object. The const { tabId } syntax destructures the tabInfo object and binds the tabInfo.tabId value on the tabId variable. closeTab() uses this tabId value to close the tab.

1import { LightningElement, wire } from 'lwc';
2import { IsConsoleNavigation, getFocusedTabInfo, closeTab } from 'lightning/platformWorkspaceApi';
3
4export class WorkspaceAPICloseTab extends LightningElement {
5    @wire(IsConsoleNavigation) isConsoleNavigation;
6
7    async closeTab() {
8        if (!this.isConsoleNavigation) {
9            return;
10        }
11        const { tabId } = await getFocusedTabInfo();
12        await closeTab(tabId);
13    }
14}

This example shows the workspaceAPICloseTab component in the lwc-recipes repo.

To make your component available for use in a Lightning console app, specify the lightning__AppPage target in the component’s configuration file.

Aura Components Sample Code

This component has a button that, when pressed, closes the currently focused tab.

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global">
2    <lightning:workspaceAPI aura:id="workspace"/>
3    <lightning:button label="Close Focused Tab" onclick="{!c.closeFocusedTab}"/>
4</aura:component>

Controller code:

1({
2    closeFocusedTab : function(component, event, helper) {
3        var workspaceAPI = component.find("workspace");
4        workspaceAPI.getFocusedTabInfo().then(function(response) {
5            var focusedTabId = response.tabId;
6            workspaceAPI.closeTab({tabId: focusedTabId});
7        })
8        .catch(function(error) {
9            console.log(error);
10        });
11    }
12})

Response

This method returns a promise that resolves to true if successful. The promise is rejected on error.