Salesforce コンソール開発者ガイド
jLightning Experience の disableUtilityPopOut()
ユーティリティのポップアウトを無効にします。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | ポップアウトを無効にするユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
| disabled | boolean |
true の場合、ポップアウトが無効になり、ポップアウトしないユーティリティのポップアウトアイコンが削除されます。ユーティリティがすでにポップアウトしている場合、ポップアウトアイコンが無効になります。 disabledText が指定されると、ポップアウトアイコンは削除されずに無効になります。 |
| disabledText | string | disabled が true に設定されている場合のポップアウトアイコンやポップインアイコンのフロート表示テキスト。省略可能。 |
サンプルコード
このコンポーネントにはボタンがあり、押すと、ユーティリティのポップアウトが無効になります。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Disable Utility Pop-Out" onclick="{! c.disableUtilityPopOut }" />
4</aura:component>コントローラーコード:
1({
2 disableUtilityPopOut : function(component, event, helper) {
3 var utilityAPI = component.find("utilitybar");
4 utilityAPI.disableUtilityPopOut({
5 disabled: true,
6 disabledText: "Pop-out is disabled"
7 });
8 }
9})応答
このメソッドは、成功時に true に解決される Promise を返します。