Lightning Experience の focusNavigationItem()
選択されたナビゲーションオブジェクトにフォーカスし、オブジェクトのホームページを開きます。通常、標準およびカスタムオブジェクトでは、オブジェクトのリストビューが開かれます。分割ビューが開いている場合、フォーカスは選択されたナビゲーションオブジェクトに当てられたままになります。このメソッドは、Lightning コンソールアプリケーションでのみ機能します。
このメソッドを使用する場合は、次の点に注意してください。
- ナビゲーション項目ですでにタブが開いている場合、フォーカスはタブに設定されます。
- 分割ビューが開いている場合、フォーカスはナビゲーションタブに設定されます。
- 分割ビューが折りたたまれている場合、ナビゲーション項目のタブが開き、フォーカスがタブに設定されます。
引数
なし
サンプルコード
このコンポーネントにはボタンがあり、押すと、ナビゲーション項目がフォーカスされ、ナビゲーション項目のホームページが開きます。大部分のオブジェクトでは、ホームページはオブジェクトのリストビューになります。
コンポーネントコード:
1<aura:component implements="flexipage:availableForAllPageTypes" access="global">
2 <lightning:navigationItemAPI aura:id="navigationItemAPI"/>
3 <lightning:button label="Focus navigation item" onclick="{!c.focusNavigationItem}"/>
4</aura:component>コントローラコード:
1({
2 focusNavigationItem : function(component, event, helper) {
3 var navigationItemAPI = component.find("navigationItemAPI");
4 navigationItemAPI.focusNavigationItem().then(function(response) {
5 console.log(response);
6 })
7 .catch(function(error) {
8 console.log(error);
9 });
10 }
11})応答
このメソッドは、成功時に true に解決される Promise を返します。エラー時には Promise は却下されます。