Weave Code
Blade Grommet Icons Laravel Package
codeat3/blade-grommet-icons
Easily add Grommet icons to Laravel Blade views with codeat3/blade-grommet-icons. This lightweight package provides a simple Blade component for rendering any Grommet icon, with support for custom sizing, colors, and extra attributes for flexible UI integration.
A package to easily make use of Grommet Icons in your Laravel Blade views.
Frequently asked questions about Blade Grommet Icons
- How do I install codeat3/blade-grommet-icons in my Laravel app?
- Install it with composer require codeat3/blade-grommet-icons. Laravel's package auto-discovery registers the service provider, so there is no config to publish, no migrations, no environment variables and no npm build step. Once installed you can render icons in any Blade view using the x-grommet-* components.
- Does codeat3/blade-grommet-icons support Laravel 13 and which PHP versions does it require?
- Version 1.11.0 is a compatibility-only release that adds Laravel 13 support, and the package targets Laravel applications running PHP 8.x. Because its real leverage is the declared ranges on blade-ui-kit/blade-icons, illuminate/support and PHP, verify those constraints against both your current and next framework version before committing. Do not infer readiness from the changelog alone.
- How do I change the size and color of a Grommet icon in a Blade view?
- Icons render as inline SVG, so colour follows currentColor by default and you can control it with ordinary Tailwind or CSS text colour classes. Sizing can be handled with a size prop or width and height utility classes such as class="w-4 h-4", depending on the convention you ratify for your design system. Any extra attributes you pass to the component are forwarded to the SVG element.
- Do I need to publish config files or run migrations after installing?
- No. Installation is limited to the Composer require plus auto-discovery, with no migrations, environment variables, permissions or build step. If you want to customise the underlying blade-icons behaviour you can publish that package's config, but this icon set itself ships nothing to publish.
- Does it work with Livewire, Inertia, Mailables and other Blade rendering paths?
- Yes. The components emit inline SVG through standard Blade, so they work unchanged in normal views, Livewire components, Inertia Blade shells, Mailables and Nova. Only API-only services and fully client-side SPA front ends gain nothing from it and should not adopt it.
- How does codeat3/blade-grommet-icons compare to blade-heroicons or Font Awesome?
- blade-heroicons and Font Awesome solve the same problem; Font Awesome typically adds a font or CSS payload, while this package emits inline SVG per icon with no extra asset pipeline. The main migration cost is design work rather than engineering work: mapping existing inline SVGs or icon-font references to Grommet component names and agreeing on sizing, colour and accessibility conventions.
- What is the Blade component naming convention for Grommet icons?
- Icons are exposed as Blade components in the x-grommet-* namespace, with names derived from the Grommet icon names, generally in kebab-case. Treat that naming contract as something to confirm with the maintainer, because a rename in a patch or minor release would silently break views. Pinning the version and grepping for component usages makes any such change easy to catch.
- Does codeat3/blade-grommet-icons work with php artisan blade-icons:cache in production?
- Icon registration goes through blade-ui-kit/blade-icons, which provides the blade-icons:cache and blade-icons:clear commands. Before relying on it in production, confirm that caching works with your read-only production filesystem and deployment flow. The cache should be rebuilt as part of your deploy rather than at runtime.
- How do I add accessibility attributes like aria-label or aria-hidden to icons?
- Pass attributes directly on the Blade component and they are forwarded to the rendered SVG. Use aria-hidden="true" for decorative icons that duplicate adjacent text, and aria-label or a title element for icons that carry meaning on their own. Agreeing on this convention early avoids accessibility regressions during the icon migration.
- Is codeat3/blade-grommet-icons safe to use in production and what are the maintenance risks?
- Technical risk is low because it is an additive, isolated dependency you can remove by deleting one Composer line plus the associated tags. The two things to track are the transitive version constraints on blade-ui-kit/blade-icons, illuminate/support and PHP, and the single-maintainer bus factor. Mitigate by pinning the version, keeping the package at a leaf of the dependency graph, and treating a fork or vendored SVG directory as a half-day task if it ever becomes load-bearing.
Weaver
How can I help you explore Laravel packages today?