Simplify your Laravel package development with automatic asset injection.
This package allows you to seamlessly insert JavaScript and CSS into web responses without requiring manual inclusion by your package users 🚀
Install the package via Composer:
composer require leuverink/asset-injector- After installing, you'll need to create a
AssetInjectorimplementation.
namespace YourPackage;
use Leuverink\AssetInjector\Contracts\AssetInjector;
class InjectAssets implements AssetInjector
{
// Used to identify your assets in the HTML response
public function identifier(): string
{
return 'MY_PACKAGE';
}
// You can opt in to asset injection by implementing your own checks.
// For example if a package user can control this via config file, or when your end user hits a middleware
public function enabled(): bool
{
return true;
}
// Will inject return value in head tag or before html close if no head is present
public function inject(): string
{
$js = file_get_contents(__DIR__ . '/../build/my-package.js');
$css = file_get_contents(__DIR__ . '/../build/my-package.css');
return <<< HTML
<script type="module">{$js}</script>
<style>{$css}</style>
HTML;
}
}- Register the implementation in your package's Service Provider.
namespace YourPackage;
use Illuminate\Support\ServiceProvider as BaseServiceProvider;
use Leuverink\AssetInjector\AssetManager;
use YourPackage\InjectAssets;
class ServiceProvider extends BaseServiceProvider
{
public function boot()
{
AssetManager::register(new InjectAssets);
}
}- Assets are automatically included in full-page responses (not partial HTML responses).
- If a
<head>tag is present, assets are injected there. Otherwise, they're inserted before the closing</html>tag. - The
identifier()method helps prevent duplicate asset injection. - Use the
enabled()method to implement conditional asset injection based on your package's configuration. - Customize the injected content by modifying the
inject()method.
Use these commands for development:
composer lint # run all linters
composer fix # run all fixers
composer analyze # run static analysis
composer baseline # generate static analysis baseline
composer test # run test suiteThis package is open-source software licensed under the MIT license.