Lightning Experience の setTabHighlighted()
指定されたタブを異なる背景色とバッジで強調表示します。タブの強調表示は、Lightning コンソールアプリケーションを再読み込みすると保持されなくなります。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| tabId | string | 強調表示するタブの ID。 |
| highlighted | boolean | タブが強調表示されるかどうか。異なる背景色を設定してユーティリティを強調表示します。 |
| options | object | 省略可能。強調表示されるタブの外観を変更する追加オプション。選択可能なオプションは次のとおりです。
|
LWC のサンプルコード
このコンポーネントは、自身が Lightning コンソールアプリケーション内にあるかどうかを確認してから、フォーカスされたタブに関する情報を返して、そのタブを強調表示します。
Aura コンポーネントのサンプルコード
このコンポーネントにはボタンがあり、押すと、フォーカスされているタブが強調表示されます。
コンポーネントコード:
コントローラコード:
応答
このメソッドは、成功時に変更されたタブを表す tabInfo オブジェクトに解決される Promise を返します。tabInfo オブジェクトは、ワークスペースタブに関する情報の JSON 配列で、各サブタブに関する情報の配列がネストされています。tabInfo オブジェクトの構造を次に示します。