Lightning Experience の setUtilityHighlighted()
バッジや目立つ背景色を表示して、ユーティリティを強調表示します。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | 強調表示するユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
| highlighted | boolean | ユーティリティが強調表示されるかどうか。異なる背景色を設定してユーティリティを強調表示します。 |
サンプルコード
ユーティリティバーで使用される 1 列の Lightning ページにこのコンポーネントが追加されている場合、ボタンを押すとユーティリティが強調表示されます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Set Utility Highlighted" onclick="{! c.setUtilityHighlighted}" />
4</aura:component>コントローラコード:
1({
2 setUtilityHighlighted : function(component, event, helper) {
3 var utilityAPI = component.find("utilitybar");
4 utilityAPI.setUtilityHighlighted({
5 highlighted: true
6 });
7 }
8})応答
このメソッドは、成功時に true に解決される Promise を返します。