ycs77/inertia-engage

Opinionated Inertia.js Laravel & Vue helper library, to scaffolding and extended your Inertia.js application.

v1.5.1 2024-10-25 08:28 UTC

Requires

• php: >=8.2
• ergebnis/json-printer: ^3.5
• inertiajs/inertia-laravel: >=1.0
• laravel/framework: >=11.0
• laravel/prompts: ^0.1
• symfony/console: >=7.0

Requires (Dev)

• laravel/pint: ^1.13
• orchestra/testbench: >=9.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-laravel: ^2.4

MIT

• Lucas Yang

• laravel
• inertia

README

Opinionated Inertia.js Laravel & Vue helper library, to scaffolding and extended your Inertia.js application.

Features:

• Error Handler
• Pagination
• IDE Helper

Supported Versions

Installation

Install the package via composer:

composer require ycs77/inertia-engage

Publish the config file is optional:

php artisan vendor:publish --tag=inertia-engage-config

Then install the Inertia.js scaffold into this application:

php artisan inertia:install
# or export with TypeScript
php artisan inertia:install --ts

Or just initialize the Laravel project:

php artisan laravel:initial

Error Handler

If you running the inertia:install command, below will automatically added.

Publish the error page:

php artisan inertia:ui error
# export with TypeScript
php artisan inertia:ui error --ts

Then extends the exception handler for Inertia application:

bootstrap/providers.php.php

<?php

use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Http\Request;
use Inertia\Inertia;
use Symfony\Component\HttpFoundation\Response;

->withExceptions(function (Exceptions $exceptions) {
    $exceptions->respond(function (Response $response, Throwable $e, Request $request) {
        return Inertia::exception()->handle($request, $response, $e);
    });
})

Pagination

Publish pagination component and css file:

php artisan inertia:ui pagination
# or export with TypeScript
php artisan inertia:ui pagination --ts

IDE Helper

If missing the IDE helper file in the Inertia Laravel package, you can publish the IDE helper file:

php artisan inertia:ide-helper

License

The MIT License (MIT). Please see License File for more information.