Laravel Data Providers for Inertia.js
Data providers encapsulate logic for Inertia views, keep your controllers clean and simple.
Installation
We assume you've already got Inertia installed, so you can just install this package via composer:
composer require webfox/laravel-inertia-dataproviders
Usage
Using a Data Provider
Data providers take advantage of the fact that Inertia::render can accept Arrayables as well as standard arrays and so are used
instead a standard array in the Inertia::render method. They can also be used as discrete attributes in the data array.
use App\Models\Demo;
use App\DataProviders\DemoDataProvider;
class DemoController extends Controller
{
public function show(Demo $demo)
{
return Inertia::render('DemoPage', new DemoDataProvider($demo));
}
public function edit(Demo $demo)
{
return Inertia::render('DemoPage', [
'some' => 'data',
'more' => 'data',
'demo' => new DemoDataProvider($demo),
]);
}
}
What Does a Data Provider Look Like?
Data providers can live anywhere, but we'll use App/Http/DataProviders for this example.
The simplest data provider is just a class that extends DataProvider, any public methods or properties will be available to the page as data.
A fully featured data provider might look like this:
<?php
declare(strict_types=1);
namespace App\Http\DataProviders;
use Inertia\LazyProp;
use App\Services\InjectedDependency;
use Webfox\InertiaDataProviders\DataProvider;
class DemoDataProvider extends DataProvider
{
public function __construct(
/*
* All public properties are automatically available in the page
* This would be available to the page as `demo`
*/
public Demo $demo;
)
{
/*
* Data providers have a `staticData` property, which you can use to add any data that doesn't warrant a full
* property or separate method
*/
$this->staticData = [
/*
* This will be available to the page as `title`
*/
'title' => $this->calculateTitle($demo),
];
}
/*
* All public methods are automatically evaluated as data and provided to the page.
* ALWAYS included on first visit, OPTIONALLY included on partial reloads, ALWAYS evaluated
* This would be available to the page as `someData`.
* Additionally these methods are resolved through Laravel's service container, so any parameters will be automatically resolved.
*/
public function someData(InjectedDependency $example): array
{
return [
'some' => $example->doThingWith('some'),
'more' => 'data',
];
}
/*
* If a method returns a `Closure` it will be evaluated as a lazy property.
* ALWAYS included on first visit, OPTIONALLY included on partial reloads, ONLY evaluated when needed
* Additionally the callback methods are resolved through Laravel's service container, so any parameters will be automatically resolved.
* @see https://inertiajs.com/partial-reloads#lazy-data-evaluation
*/
public function quickLazyExample(): Closure
{
return function(InjectedDependency $example): string {
return $example->formatName($this->demo->user->name);
};
}
/*
* If a method is typed to return a LazyProp, it will only be evaluated when requested following inertia's rules for lazy data evaluation
* NEVER included on first visit, OPTIONALLY included on partial reloads, ONLY evaluated when needed
* Additionally the lazy callback methods are resolved through Laravel's service container, so any parameters will be automatically resolved.
* @see https://inertiajs.com/partial-reloads#lazy-data-evaluation
*/
public function lazyExample(): LazyProp
{
return Inertia::lazy(
fn (InjectedDependency $example) => $example->aHeavyCalculation($this->demo)
);
}
/*
* `protected` and `private` methods are not available to the page
*/
protected function calculateTitle(Demo $demo): string
{
return $demo->name . ' Demo';
}
}
Using Multiple Data Providers
Sometimes you might find yourself wanting to return multiple DataProviders DataProvider::collection is the method for you. Each DataProvider in the collection will be evaluated and merged into the page's data, later values from DataProviders will override earlier DataProviders.
use App\Models\Demo;
use App\DataProviders\TabDataProvider;
use App\DataProviders\DemoDataProvider;
class DemoController extends Controller
{
public function show(Demo $demo)
{
return Inertia::render('DemoPage', DataProvider::collection(
new TabDataProvider(current: 'demo'),
new DemoDataProvider($demo),
));
}
}
You can also conditionally include DataProviders in the collection:
use App\Models\Demo;
use App\DataProviders\TabDataProvider;
use App\DataProviders\DemoDataProvider;
use App\DataProviders\EditDemoDataProvider;
use App\DataProviders\CreateVenueDataProvider;
class DemoController extends Controller
{
public function show(Demo $demo)
{
return Inertia::render('DemoPage', DataProvider::collection(
new TabDataProvider(current: 'demo'),
new DemoDataProvider($demo),
)->when($demo->has_venue, function (DataProviderCollection $collection) use($demo) {
$collection->push(new CreateVenueDataProvider($demo));
})
->unless($demo->locked, function (DataProviderCollection $collection) use($demo) {
$collection->push(new EditDemoDataProvider($demo));
}));
}
}
Or you can use the DataProviderCollection::add method to add a DataProvider to the collection later:
use App\Models\Demo;
use App\DataProviders\TabDataProvider;
use App\DataProviders\DemoDataProvider;
use App\DataProviders\CreateVenueDataProvider;
class DemoController extends Controller
{
public function show(Demo $demo)
{
$pageData = DataProvider::collection(
new TabDataProvider(current: 'demo'),
new DemoDataProvider($demo),
);
if($demo->has_venue) {
$pageData->add(new CreateVenueDataProvider($demo));
}
return Inertia::render('DemoPage', $pageData);
}
}
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
We welcome all contributors to the project.
License
The MIT License (MIT). Please see License File for more information.
1 Jan 3, 2022
1 Oct 29, 2021
41 Dec 19, 2022
16 Nov 16, 2022
6 Dec 28, 2022
21 May 23, 2022
79 Aug 6, 2022
808 Dec 31, 2022
62 Aug 15, 2021
11 Dec 30, 2022
7 Dec 12, 2022
3 Oct 21, 2021
50 Jan 4, 2023
0 Dec 26, 2021
121 Dec 31, 2022
3 Apr 4, 2022
8 Dec 6, 2022
21 Dec 16, 2022