README

What?

Use Svelte Components from within your Laravel Blade Templates -- totally seamlessly.

Why?

Modern JavaScript has been a gift and a curse. An amazing gift for developing front ends, plus a whole lot of cursing trying to get it all configured and setup.

Things that used to be very simple became increasingly complex overnight. With build steps, webpack, SSR, code-splitting, and everything else, it can get overwhelming quick.

There have been several awesome attempts to get the best of both worlds, especially within the Laravel community. Projects like Livewire and Alpine.js are amazing and really inspired the creation of this project.

Lately I have really taken a liking to Svelte, a different take on the typical React/Vue style application. It was refreshing to get declarative, reactive, single file components, without all the boilerplate. But coming from PHP & Laravel, I still want my Blade templates and server side rendering (ya know the old school way).

Normally in this situation, Laravel is just there to serve the shell of the DOM, and then have Svelte/Vue/React take over your entire body tag, or very large chunks of your DOM.

But I like eating my cake too, and so this little project was born.

How?

This package has two main pieces.

A Laravel Mix plugin that compiles each of your Svelte components into their own bite-sized JS files
A Blade Pre-Compiler that scans Blade templates identifies your Svelte component tags, and loads the right component JS automatically

Install Laravel Svelte Direct

composer require nickpoulos/laravel-svelte-direct

Configure Laravel Mix

webpack.mix.js

const mix = require('laravel-mix');
require('./vendor/nickpoulos/laravel-svelte-direct/js/mix');

mix.svelteDirect('resources/js/Components', 'public/js');

Write Your Svelte Components

Write your Svelte components as your normally would, except for two small additions that we will add to the top of our file. Both are part of the official Svelte docs/spec and are not custom syntax.

<!-- svelte-ignore missing-custom-element-compile-options -->
<svelte:options tag="flash-message" />

The options tag tells Svelte (and Svelte Direct), what the component's HTML tag should be. Normally this technique is only used in Svelte when compiling to WebComponents (more on that later). But it is the perfect mechanism for our cause as well.

The comment tag tells Svelte to ignore when we don't have customElement set to true.

Configure Blade Template

In your applications's main Blade layout/component, add the @stack('sveltedirect')'above your ending </body> tag.

Feel free to add your Svelte component anywhere inside the Blade HTML. You will notice the tag we use in the HTML below matches the <svelte:options> tag attribute above.

example.blade.php

<!doctype html>
<html>
<head>
    <title>My Example App</title>    
</head>
<body>
<div class="container">

    <!-- example Svelte components here --> 
    <app-header>
        <flash-message type="success" message="test" />
    </app-header>
    <!-- end components -->
    
</div>

<script type="text/javascript">
    // tie your components together using vanilla js or something ike alpine
</script>

<!-- START Svelte Direct Component JavaScript -->
@stack('sveltedirect')
<!-- END Svelte Direct Component JavaScript -->

</body>
</html>

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

nickpoulos / laravel-svelte-direct

Maintainers

Details