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