A package to easily add transpiled & minified scripts to your blade components.
<button class="btn" onlick="myFunction()">{{ $slot }}</button>
<x-script>
function myFunction() {
// Do something.
}
</x-script>
In case you want to add javascript functionality to a blade component, you can write it directly in the script tag. However, the script will then not be minified and if a component is used multiple times, the script tag will also be included multiple times.
Blade Script solves these problems. The javascript code can be minified in production and each script tag is only included once all without running a compiler separately. Also only required scripts are included.
Additionally there is the possibility to add transpilers like babel.
The package can be easily installed via composer.
composer requrie cbl/blade-script
Now the necessary assets must be published. This includes the script.php config and the storage folder where the compiled scripts are stored.
php artisan vendor:publish --provider="BladeScript\ServiceProvider"
The blade component x-scripts
includes all required scripts, so it may be
placed at the very bottom of your body.
<body>
...
<x-scripts />
</body>
Each blade component can contain exactly one x-script
component. Your scripts
can then be written inside the wrapper like so.
<button class="btn" onlick="myFunction()">{{ $slot }}</button>
<x-script>
myFunction() {
// Do something.
}
</x-script>
Blade scripts share the same behavior as Views. As suggested in the
View documentation, the
script:cache
command can be added to your deployment workflow to ensure that
all scripts are compiled and thus improve performance.
php artisan script:cache
You may use the script:clear
command to clear the script cache:
php artisan script:clear
You can easily add transpilers to the compiler, the following example explains how to create and include a transpiler.
First you have to create a transpiler class that implements the
BladeScript\Contracts\Transpiler
contract.
namespace BladeBabel;
use Babel\Transpiler as Babel;
use BladeScript\Contracts\Transpiler;
class BabelTranspiler implements Transpiler
{
public function transpile($script)
{
return Babel::transform($script);
}
}
The transpiler can now be added to the compiler in your service provider like so:
namespace BladeBabel;
use Illuminate\Support\ServiceProvider;
class BabelServiceProvider extends ServiceProvider
{
public function register()
{
$this->app->afterResolving('script.compiler', function ($compiler) {
$compiler->addTranspiler(new BabelTranspiler);
});
}
}