Overlays

dialog

Modal dialog with focus trap, backdrop, and Esc-to-close.

<x-ui.dialog title="Are you sure?" description="This action cannot be undone.">
    <x-slot:trigger>
        <x-ui.button variant="outline">Open dialog</x-ui.button>
    </x-slot:trigger>

    <p class="text-sm text-muted-foreground">
        This will permanently delete the project and all of its data.
    </p>

    <x-slot:footer>
        <x-ui.button variant="outline"
            x-on:click="open = false">Cancel</x-ui.button>
        <x-ui.button variant="destructive">Delete</x-ui.button>
    </x-slot:footer>
</x-ui.dialog>

Installation

php artisan ui:add dialog

1. Install dependencies

  • composer: gehrisandro/tailwind-merge-laravel
  • npm: alpinejs
  • npm: @alpinejs/focus
  • component: button

2. Copy the source into resources/views/components/ui/

resources/views/components/ui/dialog.blade.php

@props([
    'title' => null,
    'description' => null,
])

@php
    $overlay = \TailwindMerge\Laravel\Facades\TailwindMerge::merge(
        'fixed inset-0 z-50 bg-black/50',
    );

    $panel = \TailwindMerge\Laravel\Facades\TailwindMerge::merge(
        'fixed left-1/2 top-1/2 z-50 grid w-full max-w-[calc(100%-2rem)] -translate-x-1/2 -translate-y-1/2 gap-4 rounded-lg border bg-background p-6 shadow-lg sm:max-w-lg',
        $attributes->get('class'),
    );
@endphp

<div x-data="{ open: false }" @keydown.escape.window="open = false"
    {{ $attributes->except('class') }}>
    <div @click="open = true">
        {{ $trigger }}
    </div>

    <template x-teleport="body">
        <div x-show="open" x-cloak>
            <div class="{{ $overlay }}" x-show="open" x-transition.opacity
                @click="open = false"></div>

            <div class="{{ $panel }}" role="dialog" aria-modal="true"
                @if ($title) aria-labelledby="dialog-title" @endif
                @if ($description) aria-describedby="dialog-description" @endif
                x-show="open" x-transition x-trap.noscroll.inert="open">
                @if ($title || $description)
                    <div class="flex flex-col gap-2 text-center sm:text-left">
                        @if ($title)
                            <h2 id="dialog-title"
                                class="text-lg font-semibold leading-none">
                                {{ $title }}
                            </h2>
                        @endif
                        @if ($description)
                            <p id="dialog-description"
                                class="text-sm text-muted-foreground">
                                {{ $description }}
                            </p>
                        @endif
                    </div>
                @endif

                {{ $slot }}

                @isset($footer)
                    <div
                        class="flex flex-col-reverse gap-2 sm:flex-row sm:justify-end">
                        {{ $footer }}
                    </div>
                @endisset

                <button type="button"
                    class="absolute right-4 top-4 rounded-xs opacity-70 outline-none transition-opacity hover:opacity-100 focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] disabled:pointer-events-none [&_svg]:size-4 [&_svg]:shrink-0"
                    aria-label="Close" @click="open = false">
                    <svg xmlns="http://www.w3.org/2000/svg" width="16"
                        height="16" viewBox="0 0 24 24" fill="none"
                        stroke="currentColor" stroke-width="2"
                        stroke-linecap="round" stroke-linejoin="round"
                        aria-hidden="true">
                        <path d="M18 6 6 18" />
                        <path d="m6 6 12 12" />
                    </svg>
                </button>
            </div>
        </div>
    </template>
</div>

Usage

<x-ui.dialog title="Are you sure?" description="This action cannot be undone.">
    <x-slot:trigger>
        <x-ui.button variant="outline">Open dialog</x-ui.button>
    </x-slot:trigger>

    <p class="text-sm text-muted-foreground">Dialog body content.</p>

    <x-slot:footer>
        <x-ui.button variant="outline"
            x-on:click="open = false">Cancel</x-ui.button>
        <x-ui.button variant="destructive">Delete</x-ui.button>
    </x-slot:footer>
</x-ui.dialog>

Requires Alpine.js with the @alpinejs/focus plugin (x-trap) for the focus trap. The `trigger` slot opens the dialog; an optional `footer` slot renders action buttons.