Salesforce LWC學習(九) Quick Action in LWC

我們在lightning開發中，quick action是一個常用的功能，很可惜的是，lwc目前還不支持單獨的custom quick action操作，只能嵌套在aura中使用才能發揮作用。

官方也給我們提供了如何進行嵌套，簡單代碼嵌套如下所示：

<aura:component implements="force:lightningQuickActionWithoutHeader,force:hasRecordId,flexipage:availableForRecordHome">
    <!--This is a lwc component-->  
    <c:testComponentForLwc>
</aura:component>    

我們只需要聲明一個aura的components然后實現force:lightningQuickAction/force:lightningQuickActionWithoutHeader並且使用c:引入相關的lwc即可。這里可能會提到兩個問題：

1. 一個對象可能有多個quick action對應多個lwc component，是否需要對應多個aura component還是一個就可以搞定？
2. lwc不支持quick action所以沒法關閉或者調用aura中關閉quick action的方法，那么lwc中如何去關閉quick action彈出的modal？
3. lwc quick action更新某個字段以后沒法及時刷新父的詳情頁面，如何去解決？

針對這兩個問題，我們一個一個進行解決。

針對第一個問題，我們使用lightning:quickActionAPI 組件，然后調用其getSelectedActions方法獲取Promise然后解析即可實現。當然此組件還有很多經常用到的好用的功能，感興趣的小伙伴自己讀一下：https://developer.salesforce.com/docs/component-library/bundle/lightning:quickActionAPI/documentation

針對第二/三個問題，盡管lwc沒法獲取或者關閉quick action，但是aura component是可以的，我們只需要在aura中進行事件監聽，然后在Lwc component中注冊事件即可實現。因為aura的事件監聽處理可以捕捉到lwc的事件注冊。 OK，那我們開始直接上代碼：

quickActionService.cmp：引入lightning:quickActionAPI從而可以獲得當前選擇的quick action name，然后根據quick action name去決定顯示哪個lwc組件，並且對testLookUpFowLwc組件進行了兩個事件監聽處理，分別是refreshview以及closemodal。

<aura:component implements="force:lightningQuickActionWithoutHeader,force:hasRecordId,flexipage:availableForRecordHome">
    <aura:attribute name="quickActionName" type="String"/>
    <lightning:quickActionAPI aura:id="quickActionAPI" />
    <aura:handler name="init" value="this" action="{!c.doInit}"/>
    <aura:if isTrue="{!v.quickActionName == 'Account.test_another'}">
        <c:testLookUpForLwc onrefreshview="{c.refreshView}" onclosemodal="{!c.closeModal}"/>
    </aura:if>
    <aura:if isTrue="{!v.quickActionName == 'Account.test_action'}">
        show area with test action
    </aura:if>
</aura:component>    

quickActionServiceController.js：對getSelectedActions進行解析，對事件調用force:event事件進行refresh view以及close action。

({
    doInit : function(component, event, helper) {
        var actionAPI = component.find("quickActionAPI");

        actionAPI.getSelectedActions().then(function(result){
            console.log(JSON.stringify(result));
            if(result) {
                console.log(result.actions[0]);
                var actionName = result.actions[0].actionName;
                component.set('v.quickActionName',actionName);
            }
        }).catch(function(e){

        });
    },

    refreshView : function(component,event,helper) {
        $A.get('e.force:refreshView').fire();
    },
    closeModal : function(component,event,helper) {
        $A.get("e.force:closeQuickAction").fire()
    }
})

testLookUpForLwc.html：展示button，點擊button按鈕執行handleClose

<template>
    <lightning-button type="button" label="submit and close" variant="brand" onclick={handleClose}></lightning-button>
    
</template>

testLookUpForLwc.js：方法注冊refreshview以及closemodal事件，從而讓父去監聽以及執行事件。

import { LightningElement,track } from 'lwc';

export default class TestLookUpForLwc extends LightningElement {
    
    handleClose(event) {
        this.dispatchEvent(new CustomEvent('refreshview'));
        this.dispatchEvent(new CustomEvent('closemodal'));
    }

}

顯示效果：我們在account上創建兩個quick action，分別是test_action以及test_another，分別綁定了這個aura，當我們點擊以后test_action以后，打印出來的日志結果。

 

 總結：篇中主要講述lwc如何配合aura實現quick action以及相關的refresh / close 的功能，針對refresh / close不止針對quick action,針對其他的lwc的設計同樣有效。篇中有錯誤地方歡迎指出，有問題歡迎留言。