Lightning Experience の toggleModalMode()
ユーティリティのモーダルモードを切り替えます。モーダルモードの場合、ユーティリティパネルの表示中、オーバーレイによってユーザーはコンソールを使用できなくなります。
引数
| 名前 | 型 | 説明 |
|---|---|---|
| utilityId | string | 開くユーティリティの ID。ユーティリティ内からコールする場合は省略可能。 |
| enableModalMode | boolean | モーダルモードを有効にするかどうか。 |
サンプルコード
ユーティリティバーで使用される 1 列の Lightning ページにこのコンポーネントが追加されている場合、ボタンを押すとモーダルモードが切り替わります。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global" >
2 <lightning:utilityBarAPI aura:id="utilitybar" />
3 <lightning:button label="Toggle Modal Mode" onclick="{! c.toggleModalMode }" />
4</aura:component>コントローラーコード:
1({
2 toggleModalMode : function(component, event, helper) {
3 var utilityAPI = component.find("utilitybar");
4 utilityAPI.toggleModalMode({
5 enableModalMode: true
6 });
7 }
8})応答
このメソッドは、成功時に true に解決される Promise を返します。