Salesforce コンソール開発者ガイド
jLightning Experience の setUtilityIcon()
ユーティリティのアイコンを設定します。このアイコンは、ユーティリティバーに表示されます。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | アイコンを設定するユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
| icon | string | ユーティリティバーに表示される SLDS ユーティリティアイコンキー。SLDS リファレンスサイトでユーティリティアイコンキーの完全なリストを確認してください。 |
| options | object | 省略可能。ユーティリティアイコンの外観を変更する追加オプション。 |
)、warning (
)、error (
) です。サンプルコード
ユーティリティバーで使用される 1 列の Lightning ページにこのコンポーネントが追加されている場合、ボタンを押すとユーティリティのアイコンが緑色の SLDS の [insert_tag_field] アイコンに設定されます。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Set Utility Icon" onclick="{! c.setUtilityIcon }" />
4</aura:component>コントローラーコード:
1({
2 setUtilityIcon : function(component, event, helper) {
3 var utilityAPI = component.find("utilitybar");
4 utilityAPI.setUtilityIcon({
5 icon: “insert_tag_field”
6 options:{
7 iconVariant:"success"
8 }
9 });
10 }
11})応答
このメソッドは、成功時に true に解���される Promise を返します。