Salesforce LWC学习(十九) 针对 lightning-input-field的label值重写

时间:2022-07-22
本文章向大家介绍Salesforce LWC学习(十九) 针对 lightning-input-field的label值重写,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

本篇参考:

https://salesforcediaries.com/2020/02/24/how-to-override-lightning-input-field-label-in-lightning-web-component/

https://developer.salesforce.com/docs/component-library/bundle/lightning-input-field/documentation

https://www.lightningdesignsystem.com/components/input/

https://www.cnblogs.com/zero-zyq/p/11380449.html 篇中,我们了解了 LDS的使用,其中让我们用起来很爽的莫过于使用lightning-input-field。

lightning-input-field因为他独特的魅力深受开发人员喜爱,看到了他,莫名的让人会想起 lightning:inputField以及apex:inputField,字段类型声明什么无所谓,只需要使用此标签绑定字段便可以渲染成需要的标准页面的效果。使用时需要将其放在 lightning-record-edit-form中,当然,使用 lightning-record-edit-form搭配 lightning-input-field时需要考虑几点:

1. 当前 user对 lighting-record-edit-form绑定的表应该有 create或者edit权限;

2. 当前的 user应该对 lightning-input-field绑定的字段有 visible的权限。

3. lightning-record-edit-form不是支持所有的表,只有在其允许使用的表中才可以使用此标签以及此字段,比如 Event/Task就不支持这个组件,对Event / Task就没法使用 lightning-event-edit-form以及 lightning-input-field;

4. lightning-input-field不是支持所有的字段类型,尽管大部分都支持,但是有一小部分还是不支持的,比如 master-detail类型。

说完限制,再说一下使用场景。lightning-record-edit-form 通常可以用在两种情况:

1. 自定义编辑页面

2. 检索列表功能中的form查询页面

所以针对具体的需求进行适当的使用亦或废弃找其他的解决方案基于这些限制以及这些功能,我们根据不同的case去进行不同的封装。

比如表单中只是针对 text/currency等等类型,我们可以使用 lightning-input,针对 picklist我们可以使用 lightning-combobox,这种基础类型换其他方案问题不大。

但是如果表单中存在针对 lookup这种弹出组件时,我们却很为难,因为除了 lightning-input-field以外,其他的没有直接的办法去展示以及实现此种功能。自定义的组件虽可以完成大部分其需要的功能,却无法和标准的相匹配,所以此种情况很容易借壳搞定类似需求。

如何借壳? 需要满足哪些条件?

1. 在lightning-record-edit-form支持的表中创建 lookup字段,关联到需要选择的表,比如自定义表中创建一个字段,关联到user;

2. 保证当前的这个表对可以访问此组件的 所有的 profile都有 创建或者编辑数据的权限,如果没有创建或者编辑的权限, lightning-record-edit-form绑定此表没有编辑的能力和效果;

3. 保证可以访问此组件的所有的 profile对创建的这个字段的 FLS都要editable。

我们在Account表中创建两个字段,分别为User_For_LookUp__c关联到User表以及Contact_For_Lookup__c用来关联到Contact表。

eventCreate.html:用于关联需要创建Event的几个字段,因为Event不能使用 lightning-record-edit-form,所以将 暂时绑定 到Account,OwnerId使用 User_For_LookUp__c借壳绑定,WhoId使用Contact_For_Lookup__c绑定。

<template>
    <lightning-card>
        <lightning-record-edit-form 
            object-api-name='Account' 
            onsubmit={saveEvent}
        >
            <lightning-layout multiple-rows="true">
                <lightning-layout-item size="6" padding="around-small" flexibility='auto'>
                    <lightning-input type="text" label="Subject" name="subject" value={eventWrapper.subject} onchange={handleInputChange}></lightning-input>
                </lightning-layout-item>
                <lightning-layout-item size="6" padding="around-small" flexibility='auto'>
                </lightning-layout-item>
                <lightning-layout-item padding="around-small" flexibility='auto' size='6'>
                    <lightning-input label="Start Date" type="datetime" name="startDateTime" value={eventWrapper.startDateTime} date-style="long" required onchange={handleInputChange}></lightning-input>
                </lightning-layout-item>
                <lightning-layout-item padding="around-small" flexibility='auto' size='6'>
                    <lightning-input label="End Date" type="datetime" name="endDateTime" value={eventWrapper.endDateTime} date-style="long" required onchange={handleInputChange}></lightning-input>
                </lightning-layout-item>
                <lightning-layout-item size="6" padding="around-small" flexibility='auto'>
                    <lightning-input-field
                        field-name="User_For_LookUp__c"
                        variant="label-stacked"
                    ></lightning-input-field>
                </lightning-layout-item>
                <lightning-layout-item size="6" padding="around-small" flexibility='auto'>
                    <lightning-input-field
                        field-name="Contact_For_Lookup__c"
                        variant="label-stacked"
                    ></lightning-input-field>
                </lightning-layout-item>
            </lightning-layout>
            <lightning-layout>
                <lightning-layout-item>
                    <lightning-button-group>
                        <lightning-button type="submit" label="Submit"></lightning-button>
                        <lightning-button label="cancel"></lightning-button>
                    </lightning-button-group>
                </lightning-layout-item>
            </lightning-layout>
        </lightning-record-edit-form>
    </lightning-card>
</template>

eventCreate.js:当 saveEvent方法时,先组织默认提交,通过event.detail.fields可以获取到 record-edit-form中的所有的 lightning-input-field的绑定值内容,在给自定义的wrapper字段赋值传递到后台即可。

import { LightningElement,track } from 'lwc';

export default class EventCreate extends LightningElement {

    @track eventWrapper = {
        subject : '',
        whoId : '',
        ownerId : '',
        startDateTime : '',
        endDateTime : ''
    };

    handleInputChange(event) {
        let eventSourceName = event.target.name;
        if(eventSourceName === 'subject') {
            this.eventWrapper.subject = event.target.value;
        } else if(eventSourceName === 'startDateTime') {
            this.eventWrapper.startDateTime = event.target.value;
        } else if(eventSourceName === 'endDateTime') {
            this.eventWrapper.endDateTime = event.target.value;
        }
    }

    saveEvent(event) {
        event.preventDefault();
        const allFields = event.detail.fields;
        this.eventWrapper.whoId = allFields.User_For_LookUp__c;
        this.eventWrapper.ownerId = allFields.Contact_For_Lookup__c;
        console.log(JSON.stringify(this.eventWrapper));
    }

}

效果展示:当我们录入完基本信息点击 submit按钮以后,console栏展示了返回的内容。

上面我们使用的variant是label-stacked,可以看到User_For_LookUp__c字段展示的 label是 User For LookUp,但是我们想要展示他的值是 Owner Id,然而lightning-input-field中没有任何属性可以更改其label值,应该如何操作呢?这个时候可以看前辈们提供的方法了,原操作可以查看片头链接。

秘密就在variant中,lwc针对此组件存在一个variant为label-hidden,即不展示 label信息,我们只需要隐藏这个字段的label值,然后通过lightning design system中的提供方式重新布局展示想要的label信息即可,优化后代码如下:

修改之后的展示效果:

总结:篇中主要描述如何对 lightning-input-field的label值进行修改,允许修改以后可以极大程度上保证了字段的复用性和可扩展性。篇中有错误地方欢迎指出,有不懂欢迎留言。