Taming Blade Component Quirks with Blade UI Kit in Laravel

When working with Laravel projects like Reimpact/platform, you sometimes encounter unexpected behavior when integrating different packages. Recently, we ran into an issue where Filament's DisableBladeIconComponents middleware was preventing Heroicon components from resolving correctly in our module selector.

The Problem

Filament, a popular admin panel package for Laravel, includes a middleware that disables Blade icon components. This middleware, while helpful in some contexts, interfered with our use of <x-heroicon-*> components in the module selector. These components, which are part of the Blade Heroicons library, provide a convenient way to include SVG icons in Blade templates.

The issue arose because the middleware prevented the Blade compiler from finding and rendering the Heroicon components, leading to broken icons in the user interface.

The Solution

To address this, we switched from using <x-heroicon-*> components directly to using the @svg() directive provided by the blade-ui-kit/blade-icons package. Blade UI Kit offers a set of helpful tools and directives for working with SVG icons in Blade templates.

The @svg() directive allows you to reference SVG icons by name, and it handles the rendering process independently of Filament's middleware. This ensures that the icons are always displayed correctly, regardless of the middleware configuration.

Here's an example of how we updated our Blade template:

<!-- Before -->
<x-heroicon-home class="w-5 h-5" />

<!-- After -->
@svg('heroicon-o-home', 'w-5 h-5')

In this example, we replaced the <x-heroicon-home> component with the @svg('heroicon-o-home', 'w-5 h-5') directive. The first argument to the @svg() directive is the name of the icon, and the second argument is a string of CSS classes to apply to the icon.

The Benefits

By using the @svg() directive, we were able to:

• Avoid conflicts with Filament's DisableBladeIconComponents middleware.
• Ensure that Heroicon components are always rendered correctly.
• Maintain a consistent approach to working with SVG icons in our Blade templates.

This change demonstrates how understanding the interactions between different packages and libraries can help you overcome unexpected issues and build more robust Laravel applications.

Final Thoughts

When integrating different packages in Laravel, be mindful of potential conflicts and interactions. Leveraging tools like Blade UI Kit can provide alternative solutions that bypass these conflicts and ensure your application works as expected. Always verify your changes with thorough testing, including running static analysis tools like PHPStan and clearing the view cache.