Lightning Experience の focusTab()
ワークスペースタブまたはサブタブをフォーカスします。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
Aura コンポーネントと Lightning Web コンポーネント (LWC) のいずれの場合でも、このメソッドの引数は同じです。
| 名前 | 型 | 説明 |
|---|---|---|
| tabId | string | フォーカスするワークスペースタブまたはサブタブの ID。 |
LWC のサンプルコード
このコンポーネントには、ページの参照で取得されたタブを開いてフォーカスする関数があります。
1import { LightningElement } from 'lwc';
2import { openTab, focusTab } from 'lightning/platformWorkspaceApi';
3
4export default class MyComponent extends LightningElement {
5
6 focusNewTab(event) {
7 openTab({
8 url: '/lightning/r/Account/001R0000003HgssIAC/view',
9 label: 'Global Media'
10 }).then((tabId) => {
11 focusTab(tabId);
12 }).catch((error) => {
13 console.log(error);
14 });
15 }
16}Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、新しいタブが開き���フォーカスされます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:workspaceAPI aura:id="workspace" />
3 <lightning:button label="Focus New Tab" onclick="{! c.focusNewTab }" />
4</aura:component>コントローラーコード:
1({
2 focusNewTab : function(component, event, helper) {
3 var workspaceAPI = component.find("workspace");
4 workspaceAPI.openTab({
5 url: '/lightning/r/Account/001xx000003DI05AAG/view',
6 }).then(function(response) {
7 workspaceAPI.focusTab({tabId : response});
8 })
9 .catch(function(error) {
10 console.log(error);
11 });
12 }
13})応答
このメソッドは、成功時に true に解決される Promise を返します。