Skip to content

sbine/nova-route-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Laravel Nova Route Viewer

This Nova tool adds a route viewer section to the Nova sidebar.

It's like php artisan route:list for your browser. Supports sorting and filtering.

screenshot of Laravel Nova Route Viewer tool

Installation

Install via Composer:

composer require sbine/route-viewer

Register the tool in app/Providers/NovaServiceProvider:

public function tools()
{
    return [
        new \Sbine\RouteViewer\RouteViewer,
    ];
}

You can customize the translations by publishing them to your local folder resources/lang/vendor/route-viewer:

php artisan vendor:publish --provider="Sbine\RouteViewer\ToolServiceProvider"

Custom Columns

You can add custom columns to the route viewer table. Register them in your NovaServiceProvider or AppServiceProvider:

use Sbine\RouteViewer\RouteViewer;
use Sbine\RouteViewer\Column;

// Simple per-route resolver
RouteViewer::addColumn(
    Column::make('Domain', 'domain')
        ->using(fn (\Illuminate\Routing\Route $route) => $route->getDomain() ?? '')
);

// Batch resolver (efficient for DB lookups, avoids N+1)
RouteViewer::addColumn(
    Column::make('Hits', 'hits')
        ->usingBatch(function (array $routes): array {
            $hits = DB::table('route_hits')
                ->whereIn('uri', array_column($routes, 'uri'))
                ->groupBy('uri')
                ->pluck(DB::raw('count(*)'), 'uri');

            return array_map(fn ($r) => $hits[$r['uri']] ?? 0, $routes);
        })
);

// Non-sortable column
RouteViewer::addColumn(
    Column::make('Notes', 'notes')
        ->using(fn ($route) => config("route-notes.{$route->uri}", ''))
        ->sortable(false)
);

Custom columns are automatically searchable and sortable. Use ->sortable(false) to opt out of sorting.

Contributing

After updating frontend assets, rebuild for production:

npm install
npm run prod

Note: This project uses Laravel Mix 6, which requires Node.js 20 LTS. It is not compatible with Node.js 25+.

About

Route viewer tool for Laravel Nova

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors