Salesforce コンソール開発者ガイド
jLightning Experience の openSubtab()
ワークスペースタブ内のサブタブを開きます。サブタブがすでに開いている場合、サブタブがフォーカスされます。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
Aura コンポーネントと Lightning Web コンポーネント (LWC) のいずれの場合でも、このメソッドの引数は同じです。ただし、icon、iconAlt、および label は、LWC でのみサポートされています。
| 名前 | 型 | 説明 |
|---|---|---|
| parentTabId | string | 新しいサブタブを開くワークスペースタブの ID。親タブの ID は openSubtab() メソッドに渡す必要があります。 |
| pageReference | object | 省略可能。開く pageReference を指定します。 |
| recordId | ID | 省略可能。開くレコードを指定します。 |
| url | string |
省略可能。新しいワークスペースタブのコンテンツを表す URL。 URL は、相対 URL または絶対 URL になります。サードパーティドメインを使用するには、サイトを CSP 信頼済みサイトとして追加します。 |
| focus | boolean | 省略可能。新しいサブタブにフォーカスするかどうかを指定します。すぐにサブタブを表示するには、focus を true に設定します。バックグラウンドでサブタブを開くには、focus を false に設定します。 |
| icon | string | 省略可能。SLDS アイコンキー。SLDS リファレンスサイトでアイコンキーの完全なリストを確認してください。LWC でのみ使用できます。 |
| iconAlt | string | 省略可能。アイコンの代替テキスト。LWC でのみ使用できます。 |
| label | string | 省略可能。アイコンのテキスト表示ラベル。LWC でのみ使用できます。 |
LWC のサンプルコード
このコンポーネントは、EnclosingTabId ワイヤーアダプターを使用して、囲んでいるタブ ID を取得します。handleClick() 関数がコールされると、���在のタブ上のサブタブを開きます。コンポーネントがタブ内にもサブタブ内にも存在しない場合、tabId は null になります。
現在のタブがサブタブかどうかを確認するには、getTabInfo() を使用します。現在のタブがサブタブの場合、親タブ ID を openSubtab() 関数に渡します。
Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、ワークスペースタブ内のサブタブが開きます。
コンポーネントコード:
コントローラーコード:
応答
このメソッドは、成功時に新しいサブタブの ID に解決される Promise を返します。