Salesforce コンソール開発者ガイド
jLightning Experience の closeTab()
引数
Aura コンポーネントと Lightning Web コンポーネント (LWC) のいずれの場合でも、このメソッドの引数は同じです。
| 名前 | 型 | 説明 |
|---|---|---|
| tabId | string | 閉じるワークスペースタブまたはサブタブの ID。 |
LWC のサンプルコード
このコンポーネントは、自身が Lightning コンソールアプリケーション内にあるかどうかを確認してから、フォーカスされたタブに関する情報を返して、そのタブを閉じます。
1import { LightningElement, wire } from 'lwc';
2import { IsConsoleNavigation, getFocusedTabInfo, closeTab } from 'lightning/platformWorkspaceApi';
3
4export class FocusedTabInfoExample extends LightningElement {
5 @wire(IsConsoleNavigation) isConsoleNavigation;
6
7 handleClick() {
8 if (this.isConsoleNavigation) {
9 getFocusedTabInfo().then((tabInfo) => {
10 closeTab(tabInfo.tabId);
11 }).catch(function(error) {
12 console.log(error);
13 });
14 }
15 }
16}Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、現在フォーカスされているタブが閉じます。
コンポーネントコード:
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>コントローラーコード:
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})応答
このメソッドは、成功時に true に解決される Promise を返します。