Let’s learn Lightning Web Components (LWC) Best Practices like when to use apex class and when not to use apex class. When we should use which event in LWC?
1. LWC component Bundle naming convention
Check this post to learn about what is camelCase, PascalCase and kebab-case.
- Html file: Use camel case to name your component and use kebab-case to reference a component in the markup
- Bundle Component: use camelCase.
2. Calling Apex From LWC
There are two ways to call Apex class in the Lightning web component.
- Wire a property
- Wire a function
Wire Vs Imperatively:
As per Lightning component best practices, use @wire over imperative method invocation. @wire fits nicely in the overall Lightning Web Component reactive architecture. Salesforce is building some performance enhancement features that are only available with @wire. But there are a few use cases, that require you to use imperative Apex.
Wire Property Vs. Wire Function:
Prefer wiring to a property. This best practice applies to @wire generally (not just to wiring Apex methods).
3. Lightning Data Service (LDS)
As per LWC, the best practice is to use Lightning Data Service functions to create, Record, and delete a record over invoking Apex methods. Yes, there are some use cases where you need multiple records, then we can use Apex methods.
Lightning Data Service is built on top of User Interface API. UI API is a public Salesforce API that Salesforce uses to build Lightning Experience. As its name suggests, UI API is designed to make it easy to build Salesforce UI. UI API gives you data and metadata in a single response
Give preference to user interface form type in below order.
- lightning-record-form: It is the fastest/most productive way to build a form.
- lightning-record-view-form: If you need more control over the layout, want to handle events on individual input fields, or need to execute pre-submission
- @wire(getRecord): If you need even more control over the UI or if you need to access data without a UI.
4. Event in LWC
There are typically three approaches for communication between the components using events.
- Communication using Method in LWC ( Parent to Child )
- Custom Event Communication in Lightning Web Component (Child to Parent )
- Publish Subscriber model in Lightning Web Component Or Lightning Message Service ( Two components which don’t have a direct relation )
Here is some recommendation for the DOM Event.
- No uppercase letters
- No Spaces
- use underscores to separate words
- Don’t prefix your event name with the string “on”.
Learn more about Events in lightning web components here. Avoid using Lightning Message Service or Pubsub when not needed.
5. Streaming API, Platform Event, Change Data Capture
The lightning/empApi module provides access to methods for subscribing to a streaming channel and listening to event messages. All streaming channels are supported, including channels for platform events, PushTopic events, generic events, and Change Data Capture events. This component requires API version 44.0 or later. The lightning/empApi module uses a shared CometD connection. Example Code.
6. How to debug LWC
- Enable Debug mode
- Console warnings
- Pretty data structure
- Caution – it reduces the performance of Salesforce; make sure it’s disabled in production.
Learn about Debug Lightning Web Components.
7. Use Storable Action/ Cache Data
Use Storable Action; It will reduce calls to the Server. Syntax
Caution: A storable action might result in no call to the server. Never mark as storable an action that updates or deletes data.
For storable actions in the cache, the framework returns the cached response immediately and also refreshes the data if it’s stale. Therefore, Storable actions might have their callbacks invoked more than once: first with cached data, then with updated data from the server.
8. Build reusable Lightning Web Components
Modularity is key to creating a scalable application by reusing components. We rarely write code that is abstract enough to be reusable everywhere. You should write components not to be reused out of the box but to be abstract and composable sufficient to serve that purpose in various implementations.
Components are the building blocks of a page. We should consider the following point before dividing the components in LWC.
- Level 1: Based on its functionality
- Level 2: Based on its reusability: Passing attributes becomes a pain when you need to pass lots of inputs to the component. Consider passing objects as parameters instead of having multiple attributes.
9. Styling Reusable Components
LWC encapsulates and isolates a component’s stylesheet. Does it mean it is hard to style a child component from a parent?
- Spend some time at design time to think about possible variants of your component.
- Use CSS Custom Properties for custom styles
- Use Styling Hooks to override the styling of Base Components.
- Favor Styling Hooks and CSS Custom Properties over component attributes.
Check out how to Share CSS styles among Lightning Web Components.
10. LWC Best Practices
Here are some other LWC best practices that we can follow while building LWC components.
- Use UI API Wire Adapters and Lightning Base Components
- Allows the admin to configure your components without modifying code by configuring lists views record layouts.
- If required, don’t hesitate to restrict your component’s visibility to certain objects.
- Think whether the component needs to be tied to an object or can it be object-agnostic
- Don’t use static references
- If needed, create object-agnostic classes
- Extract utility methods outside your LWC components
- LWC components should only deal with UI-related logic.
- Favor public properties over public methods.
- Properties can be set directly in the template, while a method requires the consumer to render the component first, retrieve it back from the DOM, and invoke the method
11. Tips & Trick for Lightning Web Components
Check out our post to learn 20 Tips for Lightning Web Components (LWC) in Salesforce.
12. Lazy loading in LWC
Lazy loading helps you to load the data only when it is required. Infinite scrolling (enable-infinite-loading) enables you to load a subset of data and then load more data when users scroll to the end of the table.
Learn more about Lazy loading in Lightning Web Component.
Lightning Web Components (LWC) Best Practice Session
Hear from the man who helps make it happen: Salesforce Principal Developer Evangelist René Winkelmeyer. Building rich, efficient, and resilient Lightning Web Components is no black magic. This webinar will cover best practices around:
- Using public and private properties for effective component composition.
- When should we use @api or @track variable
- Event communication for child-to-parent as well as for sibling components (pubsub).
- Parent to Child Communication
- Child to Parent Communication
- When, and when not, to use Apex with Lightning Web Components
- Aura interoperability
Lightning Web Components (LWC) Best Practice Video
Please subscribe our YouTube and click on the bell icon to get a notification for video upload.
Lightning web component Training
New to LWC? Check our FREE LWC Training.
I hope this post will help you to learn Design Patterns and Best Practices to build reusable Lightning Web Components. Lightning web components’ best practices will help you become a good Salesforce Developer.