abdessamadbettal / livewire-best-practices Goto Github PK

This repository is a curated list of general recommendations on how to use Laravel Livewire framework to meet enterprise concerns regarding security, performance, and maintenance of Livewire components.

My name is Michael Rubél and I started using the Livewire framework in 2019 when it was new and barely stable. Back in the day, I was impressed with how fast dynamic UIs can be shipped without even using JavaScript. But like any software solution, it had its pitfalls, and I had to deal with them. The main goal of this repository is to collect the most important experiences that you need to consider when working with Livewire.

Let's begin...

Livewire requires a root element to be present in each component. Simply put, you should always write code inside <div>Your Code Here</div>. Omitting this structure will lead to a lot of problems with updating components.

Example

Don't pass large objects to Livewire components!

Avoid passing objects to the component's public properties if possible. Use primitive types: strings, integers, arrays, etc. That's because Livewire serializes/deserializes your component's payload with each request to the server to share the state between the frontend & backend. If you need to work on objects, you can create them inside a method or computed property, and then return the result of the processing.

What to consider a large object?

• Any instance large as Eloquent Model is big enough already for Livewire to slow down the component lifecycle, which may lead to poor performance on live updates. For example, if you have a component that represents the user profile (email and username), it's better to pass these parameters to properties as strings instead of the assignment of the whole model and extracting its attributes in the view. Alternatively, you can retrieve the model and then keep it as a protected property. You'll still be able to access the protected objects in Blade templates by using $this->yourProperty, but remember that protected properties should be re-hydrated manually on subsequent requests.

Note: if you use full-page components, it's recommended to fetch objects in the full-page component itself, and then pass them downstairs to the nested ones as primitive types.

If you had a Livewire component (0) that includes another Livewire component (1), then you shouldn't nest it deeper (2+). Too much nesting can make a headache when dealing with DOM diffing issues.

Also, prefer the usage of Blade components when you use nesting, they will be able to communicate with the parent's Livewire component but won't have the overhead the Livewire adds.

Example

Pass only an ID or UUID to the mount method, then map the model attributes to component properties. Remember: don't assign a whole model, but its attributes only. To avoid manually mapping model attributes, you can use fill method, or Loop Functions package.

Example

You should use wire:model's modifiers based on requirements for a particular input.
This will dramatically reduce unnecessary requests to the server.

Example

Avoid situations that may lead to passing sensitive data to the Livewire components, because they can be easily accessed from the client side by default. Always hide sensitive attributes of your models using $hidden property or explicitly filter the data you are fetching. You can as well make your properties protected in the Livewire component and then access it using $this, which will make them unavailable for the browser but accessible in Blade templates.

Instead of constantly polling the page to refresh your data, you may use event listeners to perform the component update only after a specific task was initiated from another component.

Example

You can use computed properties to avoid unnecessary database queries. Computed properties are cached within the component's lifecycle and do not perform additional SQL queries on multiple calls in the component class or in the blade view.

Example

If you face problems with updating content in your components, you must consider using wire:key construction to tell Livewire how to keep track of your DOM elements. You will typically need this when you want to update something inside a loop or if you constantly poll the root component expecting updates in the nested ones. Remember to avoid using identical wire:key for multiple components, this may lead to unpredictable bugs.

Example

Livewire has built-in Artisan commands to create, move, rename components, etc. For example, instead of manually renaming files, which could be error-prone, you can use the following command:

• php artisan livewire:move Old/Path/To/Component New/Path/To/Component

You can use loading states to make UX better. It will indicate to the user that something is happening in the background if your process is running longer than expected. To avoid flickering, you can use the delay modifier.

Example

Instead of blocking the page render until your data is fully ready, you can create a preloader using the Defer Loading feature so your UI will feel more responsive when there's a lot of data to load in the components.

wire:model is bound to the server-side request to update the state of the component, but you can optionally use AlpineJS to add client-side reactivity. Instead of using wire:model, you can use x-model from AlpineJS and sync your data with the backend using @entangle directive. This way the model will update instantly on the frontend, and the data would persist server-side after the network request reach the server. It dramatically improves the user experience on slow devices.

Example

Livewire doesn't support Form Requests internally, but instead of hardcoding the array of validation rules in the component, you may get it directly from Form Request. This way you can reuse the same validation rules in different application layers, for example in API endpoints.

Example

Even simple tests such as this one can help you a lot when you change something in the component. Livewire has a very simple yet powerful testing API. The Missing Livewire Assertions package may help you extend the set of available testing methods.

🔨 Are you working with Livewire on a daily basis? PRs are welcome.
Suggest your best practices if you don't see them on the list.
If you aren't sure if it's a good practice, you can start a discussion.