noerd / modal
Open each livewire component in a modal window.
Requires
- livewire/livewire: ^4.0
README
A stacked modal system for Laravel Livewire 4.
Open any Livewire component in a modal — no traits, no modifications to your livewire component code.
Modals can also be stacked — open another modal from inside an open one with the same $modal() call.
Installation
composer require noerd/modal
Add source path to your resources/css/app.css file
@source '../../vendor/noerd/modal/resources/views/**/*.blade.php';
Configuration
Add Assets between your head tags.
<head> ... <x-noerd::noerd-modal-assets/> ... </head>
Add Modal Component to your layout. Make sure x-data is set on the body tag or any parent element of the modal component, otherwise the modal won't work.
<body x-data> <livewire:noerd-modal/> ... </head>
Example Usage
Opening a Livewire component in a modal via a button
<button type="button" @click="$modal('livewire-component-name')"> Open Modal </button>
If you want to add parameters to your component which is opened in a modal:
<button type="button" @click="$modal('livewire-component-name', { name: 'John Doe' })"> Open Modal </button>
<?php use Livewire\Component; new class extends Component { public string $name = ''; // will be set to John Doe }; ?> <div class="p-4"> {{$name}} {{-- Will display John Doe --}} </div>
Stacked Modals
$modal(...) works the same way from inside an already-open modal — there is no extra API and no nesting limit. Calling it pushes a new modal onto the stack on top of the current one.
{{-- Inside a Livewire component that is itself open in a modal --}}
<button type="button"
@click="$modal('another-livewire-component', { count: '{{ $count }}' })">
Open another modal on top
</button>
Closing follows LIFO order:
- ESC closes only the topmost modal.
- Dispatch
closeTopModalfrom PHP/Livewire to close the top modal programmatically. - Dispatch
closeAllModalsto clear the entire stack at once.
Layering is handled automatically: only the top modal is interactive; modals beneath it are dimmed and slightly scaled down — no styling work required on your end.
Publishing the Example
To publish the example components and a demo route, run:
php artisan noerd-modal:publish-example
This will:
- Copy example components to
resources/views/components/example/ - Add a route
/noerd-example-modaltoroutes/web.php
Example Livewire Starter Kit
If you are using the Livewire Starter Kit you can edit the sidebar.blade.php like this example to make noerd modal working
<!DOCTYPE html> <html lang="{{ str_replace('_', '-', app()->getLocale()) }}" class="dark"> <head> @include('partials.head') <x-noerd::noerd-modal-assets/> </head> <body x-data class="min-h-screen bg-white dark:bg-zinc-800"> <livewire:noerd-modal/>
