Laravel Folio

LaravelFolioRoutingBlade

Laravel Folio: File-Based Routing for Blade Views

Simplify routing with Laravel Folio. Learn file-based routing conventions, route parameters, middleware, route model binding, and page components.

Laravel Folio: File-Based Routing for Blade Views

Laravel Folio introduces file-based routing to Laravel. Create a Blade file, and you've got a route. No more jumping between route files and controllers.

Installation

bash

composer require laravel/folio
php artisan folio:install

This creates a resources/views/pages directory where your page files live.

Basic Usage

Simple Pages

resources/views/pages/
├── index.blade.php          → /
├── about.blade.php          → /about
├── contact.blade.php        → /contact
└── pricing.blade.php        → /pricing

blade

{{-- resources/views/pages/about.blade.php --}}
<x-layouts.app>
    <h1>About Us</h1>
    <p>Welcome to our company.</p>
</x-layouts.app>

Nested Pages

resources/views/pages/
├── blog/
│   ├── index.blade.php      → /blog
│   └── categories.blade.php → /blog/categories
├── docs/
│   ├── index.blade.php      → /docs
│   └── getting-started.blade.php → /docs/getting-started

Route Parameters

Basic Parameters

Use brackets for dynamic segments:

resources/views/pages/
├── users/
│   └── [id].blade.php       → /users/{id}
├── posts/
│   └── [slug].blade.php     → /posts/{slug}

blade

{{-- resources/views/pages/users/[id].blade.php --}}
<?php
use function Laravel\Folio\{name};

name('users.show');
?>

<x-layouts.app>
    <h1>User #{{ $id }}</h1>
</x-layouts.app>

Multiple Parameters

resources/views/pages/
├── teams/
│   └── [team]/
│       └── members/
│           └── [member].blade.php  → /teams/{team}/members/{member}

blade

{{-- /teams/[team]/members/[member].blade.php --}}
<x-layouts.app>
    <h1>Team {{ $team }} - Member {{ $member }}</h1>
</x-layouts.app>

Catch-All Parameters

resources/views/pages/
├── docs/
│   └── [...slug].blade.php  → /docs/{slug} (catches all segments)

blade

{{-- /docs/[...slug].blade.php --}}
<?php
// $slug is an array: ['getting-started', 'installation']
// for URL: /docs/getting-started/installation
?>

<x-layouts.app>
    <nav>
        @foreach($slug as $segment)
            <span>{{ $segment }}</span>
        @endforeach
    </nav>
</x-layouts.app>

Route Model Binding

Implicit Binding

resources/views/pages/
├── users/
│   └── [User].blade.php     → /users/{user}

blade

{{-- /users/[User].blade.php --}}
<x-layouts.app>
    <h1>{{ $user->name }}</h1>
    <p>{{ $user->email }}</p>
</x-layouts.app>

Custom Keys

resources/views/pages/
├── posts/
│   └── [Post:slug].blade.php  → /posts/{post:slug}

blade

{{-- /posts/[Post:slug].blade.php --}}
<x-layouts.app>
    <article>
        <h1>{{ $post->title }}</h1>
        <div>{!! $post->content !!}</div>
    </article>
</x-layouts.app>

Soft Deleted Models

blade

<?php
use function Laravel\Folio\{withTrashed};

withTrashed();
?>

<x-layouts.app>
    @if($user->trashed())
        <div class="alert">This user has been deleted.</div>
    @endif
    <h1>{{ $user->name }}</h1>
</x-layouts.app>

Middleware

Page-Level Middleware

blade

{{-- resources/views/pages/dashboard.blade.php --}}
<?php
use function Laravel\Folio\{middleware};

middleware(['auth', 'verified']);
?>

<x-layouts.app>
    <h1>Dashboard</h1>
</x-layouts.app>

Directory-Level Middleware

php

// app/Providers/FolioServiceProvider.php
use Laravel\Folio\Folio;

public function boot(): void
{
    Folio::path(resource_path('views/pages'))
        ->middleware([
            'admin/*' => ['auth', 'admin'],
            'dashboard/*' => ['auth'],
        ]);
}

Named Routes

blade

<?php
use function Laravel\Folio\{name};

name('blog.show');
?>

<x-layouts.app>
    <article>...</article>
</x-layouts.app>

blade

{{-- In other templates --}}
<a href="{{ route('blog.show', ['slug' => $post->slug]) }}">
    {{ $post->title }}
</a>

Render Hooks

Execute code before rendering:

blade

<?php
use function Laravel\Folio\{render};
use App\Models\Post;

render(function (View $view, Post $post) {
    if (!$post->isPublished()) {
        abort(404);
    }

    // Add data to view
    return $view->with('relatedPosts', $post->related()->limit(3)->get());
});
?>

<x-layouts.app>
    <article>
        <h1>{{ $post->title }}</h1>
    </article>

    <aside>
        @foreach($relatedPosts as $related)
            <a href="/posts/{{ $related->slug }}">{{ $related->title }}</a>
        @endforeach
    </aside>
</x-layouts.app>

Page Components

Use Volt for interactive pages:

bash

composer require livewire/volt

blade

{{-- resources/views/pages/counter.blade.php --}}
<?php
use function Livewire\Volt\{state};

state(['count' => 0]);

$increment = fn () => $this->count++;
$decrement = fn () => $this->count--;
?>

<x-layouts.app>
    <div>
        <button wire:click="decrement">-</button>
        <span>{{ $count }}</span>
        <button wire:click="increment">+</button>
    </div>
</x-layouts.app>

Multiple Page Directories

php

// app/Providers/FolioServiceProvider.php
public function boot(): void
{
    Folio::path(resource_path('views/pages'));

    Folio::path(resource_path('views/admin'))
        ->uri('/admin')
        ->middleware(['auth', 'admin']);

    Folio::path(resource_path('views/api'))
        ->uri('/api/pages')
        ->middleware(['api']);
}

Real-World Structure

resources/views/pages/
├── index.blade.php              → /
├── about.blade.php              → /about
├── contact.blade.php            → /contact
├── blog/
│   ├── index.blade.php          → /blog
│   └── [Post:slug].blade.php    → /blog/{slug}
├── products/
│   ├── index.blade.php          → /products
│   ├── [category].blade.php     → /products/{category}
│   └── [category]/
│       └── [Product:slug].blade.php → /products/{category}/{slug}
├── dashboard/
│   ├── index.blade.php          → /dashboard (auth)
│   ├── settings.blade.php       → /dashboard/settings (auth)
│   └── orders/
│       ├── index.blade.php      → /dashboard/orders (auth)
│       └── [Order].blade.php    → /dashboard/orders/{order} (auth)

When to Use Folio

Use Folio for:

Marketing pages
Documentation sites
Blogs
Simple CRUD interfaces
Prototyping

Stick with controllers for:

Complex business logic
API endpoints
Heavy data processing
Multiple actions per resource

Testing

php

test('can view blog post', function () {
    $post = Post::factory()->published()->create();

    $this->get("/posts/{$post->slug}")
        ->assertOk()
        ->assertSee($post->title);
});

test('cannot view unpublished post', function () {
    $post = Post::factory()->draft()->create();

    $this->get("/posts/{$post->slug}")
        ->assertNotFound();
});

Laravel Folio simplifies routing for page-focused applications. File-based routing reduces boilerplate and makes your application structure intuitive. Combine with Volt for interactive pages without leaving Blade.

Resources

Laravel Deployment: Zero-Downtime Production Deployments

Laravel Folio: File-Based Routing for Blade Views

Laravel Folio: File-Based Routing for Blade Views

You may also like