Server-side Blade directives for React, Vue, and Svelte islands in Laravel.
Blade Islands lets you render small React, Vue, or Svelte components inside Laravel Blade views without turning your application into a full single-page app.
This package provides the Blade directives and HTML output. The browser runtime lives in the npm package blade-islands.
- Why Blade Islands?
- Installation
- Quick Start
- Available Directives
- How It Works
- Vite Setup
- Component Resolution
- Custom Root
- Preserve Mounted Islands
- Options
- Protocol
- Requirements
- Companion Package
- Blade Islands vs X
- Testing
- Contributing
- License
Blade Islands works well when your application is mostly server-rendered but still needs interactive UI in places such as:
- search inputs
- dashboards
- maps
- counters
- filters
- dialogs
Instead of building entire pages in a frontend framework, you can keep Blade as your primary rendering layer and hydrate only the parts of the page that need JavaScript.
Install the Laravel package:
composer require eznix86/blade-islandsThen install the browser runtime, your frontend framework, and the matching Vite plugin.
npm install blade-islands react react-dom @vitejs/plugin-reactnpm install blade-islands vue @vitejs/plugin-vuenpm install blade-islands svelte @sveltejs/vite-plugin-svelteAdd the runtime to resources/js/app.js, load that entry from your Blade layout, and render an island from Blade.
resources/js/app.js
import islands from 'blade-islands/react'
islands()Blade layout:
<head>
@viteReactRefresh
@vite(['resources/css/app.css', 'resources/js/app.js'])
</head>@react('ProfileCard', ['user' => $user])This mounts resources/js/islands/ProfileCard.jsx.
resources/js/app.js
import islands from 'blade-islands/vue'
islands()Blade layout:
<head>
@vite(['resources/css/app.css', 'resources/js/app.js'])
</head>@vue('ProfileCard', ['user' => $user])This mounts resources/js/islands/ProfileCard.vue.
resources/js/app.js
import islands from 'blade-islands/svelte'
islands()Blade layout:
<head>
@vite(['resources/css/app.css', 'resources/js/app.js'])
</head>@svelte('ProfileCard', ['user' => $user])This mounts resources/js/islands/ProfileCard.svelte.
Blade Islands provides three directives:
@react('Dashboard', ['user' => $user])
@vue('Support/TicketList', ['tickets' => $tickets])
@svelte('Cart/Drawer', ['count' => $count])Blade Islands has two parts:
- this package renders island placeholders from Blade
- the npm runtime scans the DOM and mounts the matching frontend component
For example:
@react('Account/UsageChart', ['stats' => $stats])renders the metadata needed to mount:
resources/js/islands/Account/UsageChart.jsx
Register the plugin for the framework you use.
import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'
export default defineConfig({
plugins: [react()],
})If your Laravel layout loads a React entrypoint in development, include:
@viteReactRefreshimport { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
export default defineConfig({
plugins: [vue()],
})import { defineConfig } from 'vite'
import { svelte } from '@sveltejs/vite-plugin-svelte'
export default defineConfig({
plugins: [svelte()],
})By default, the runtime looks for components in resources/js/islands.
Nested folders work automatically. For example:
@vue('Billing/Invoices/Table', [...])resolves to:
resources/js/islands/Billing/Invoices/Table.vue
This package does not resolve filesystem paths itself, but it works with custom roots configured in the browser runtime.
For example, if your frontend entry uses:
import islands from 'blade-islands/vue'
islands({
root: '/resources/js/widgets',
components: import.meta.glob('/resources/js/widgets/**/*.vue'),
})Then this Blade call:
@vue('Dashboard', [...])mounts:
resources/js/widgets/Dashboard.vue
Use preserve: true when the same DOM is processed more than once and you want Blade Islands to keep an existing island mounted instead of mounting it again.
This is useful when the page or a DOM fragment is recalculated and your frontend boot logic runs again.
@react('Dashboard/RevenueChart', ['stats' => $stats], preserve: true)
@vue('Dashboard/RevenueChart', ['stats' => $stats], preserve: true)
@svelte('Dashboard/RevenueChart', ['stats' => $stats], preserve: true)If you reuse a preserved component in a loop, pass a unique key so each island keeps its own identity:
@foreach ($products as $product)
@react('Product/Card', ['product' => $product], preserve: true, key: "product-{$product->id}")
@endforeachEach directive accepts up to four arguments:
@react($component, $props = [], $preserve = false, $key = null)$component- component name relative to the JavaScript component root$props- props encoded into the rendered HTML$preserve- keeps an existing island mounted when the same DOM is processed again$key- unique key for distinguishing repeated preserved islands
Named arguments are supported:
@react(
component: 'Dashboard',
props: ['user' => $user],
preserve: true,
key: 'dashboard-main',
)Blade Islands renders lightweight placeholders like:
<div
data-island="react"
data-component="Dashboard"
data-props="{"user":{"name":"Bruno"}}"
data-preserve="true"
data-key="react:dashboard"
></div>- PHP 8.3+
- Laravel 13+
Use this package with the separate browser runtime:
- npm package:
blade-islands - repository:
blade-islands
Inertia is a better fit when your application wants React, Vue, or Svelte to render full pages with a JavaScript-first page architecture.
Blade Islands is a better fit when your application is already Blade-first and you want to keep server-rendered pages while hydrating only selected components.
MingleJS is often used in Laravel applications that embed React or Vue components, especially in Livewire-heavy codebases.
Blade Islands is more naturally suited to Blade-first applications that want progressive enhancement with minimal architectural change. It does not depend on Livewire, and it may also be used alongside Livewire when that fits your application.
Laravel UI is a legacy scaffolding package for frontend presets and authentication views.
Blade Islands solves a different problem: adding targeted client-side interactivity to server-rendered Blade pages.
composer install
composer testContributions are welcome.
- Fork the repository
- Create a focused branch
- Add or update tests
- Run
composer test - Open a pull request with a clear summary
MIT