Stars: 419
Forks: 105
Pull Requests: 42
Issues: 84
Watchers: 18
Last Updated: 2023-07-17 14:18:12
Inertia.js Tables for Laravel Query Builder
License: MIT License
Languages: JavaScript, Vue, PHP, Shell, CSS, Blade
This package provides a DataTables-like experience for Inertia.js with support for searching, filtering, sorting, toggling columns, and pagination. It generates URLs that can be consumed by Spatie's excellent Laravel Query Builder package, with no additional logic needed. The components are styled with Tailwind CSS 3.0, but it's fully customizable with slots. The data refresh logic is based on Inertia's Ping CRM demo.
❤️ We proudly support the community by developing Laravel packages and giving them away for free. If this package saves you time or if you're relying on it professionally, please consider sponsoring the maintenance and development. Keeping track of issues and pull requests takes time, but we're happy to help!
Did you hear about Laravel Splade? 🤩
It's the magic of Inertia.js with the simplicity of Blade. Splade provides a super easy way to build Single Page Applications using Blade templates. Besides that magic SPA-feeling, it comes with more than ten components to sparkle your app and make it interactive, all without ever leaving Blade.
thead
and tbody
with support for custom cellsNote: There is currently an issue with using this package with Vite!
You need to install both the server-side package and the client-side package. Note that this package is only compatible with Laravel 9, Vue 3.0, and requires the Tailwind Forms plugin.
You can install the package via composer:
composer require protonemedia/inertiajs-tables-laravel-query-builder
The package will automatically register the Service Provider which provides a table
method you can use on an Interia Response.
With the searchInput
method, you can specify which attributes are searchable. Search queries are passed to the URL query as a filter
. This integrates seamlessly with the filtering feature of the Laravel Query Builder package.
Though it's enough to pass in the column key, you may specify a custom label and default value.
use ProtoneMedia\LaravelQueryBuilderInertiaJs\InertiaTable;
Inertia::render('Page/Index')->table(function (InertiaTable $table) {
$table->searchInput('name');
$table->searchInput(
key: 'framework',
label: 'Find your framework',
defaultValue: 'Laravel'
);
});
Select Filters are similar to search fields but use a select
element instead of an input
element. This way, you can present the user a predefined set of options. Under the hood, this uses the same filtering feature of the Laravel Query Builder package.
The selectFilter
method requires two arguments: the key, and a key-value array with the options.
Inertia::render('Page/Index')->table(function (InertiaTable $table) {
$table->selectFilter('language_code', [
'en' => 'Engels',
'nl' => 'Nederlands',
]);
});
The selectFilter
will, by default, add a no filter option to the array. You may disable this or specify a custom label for it.
Inertia::render('Page/Index')->table(function (InertiaTable $table) {
$table->selectFilter(
key: 'language_code',
options: $languages,
label: 'Language',
defaultValue: 'nl',
noFilterOption: true,
noFilterOptionLabel: 'All languages'
);
});
With the column
method, you can specify which columns you want to be toggleable, sortable, and searchable. You must pass in at least a key or label for each column.
Inertia::render('Page/Index')->table(function (InertiaTable $table) {
$table->column('name', 'User Name');
$table->column(
key: 'name',
label: 'User Name',
canBeHidden: true,
hidden: false,
sortable: true,
searchable: true
);
});
The searchable
option is a shortcut to the searchInput
method. The example below will essentially call $table->searchInput('name', 'User Name')
.
You may enable Global Search with the withGlobalSearch
method, and optionally specify a placeholder.
Inertia::render('Page/Index')->table(function (InertiaTable $table) {
$table->withGlobalSearch();
$table->withGlobalSearch('Search through the data...');
});
If you want to enable Global Search for every table by default, you may use the static defaultGlobalSearch
method, for example, in the AppServiceProvider
class:
InertiaTable::defaultGlobalSearch();
InertiaTable::defaultGlobalSearch('Default custom placeholder');
InertiaTable::defaultGlobalSearch(false); // disable
<?php
namespace App\Http\Controllers;
use App\Models\User;
use Illuminate\Support\Collection;
use Inertia\Inertia;
use ProtoneMedia\LaravelQueryBuilderInertiaJs\InertiaTable;
use Spatie\QueryBuilder\AllowedFilter;
use Spatie\QueryBuilder\QueryBuilder;
class UserIndexController
{
public function __invoke()
{
$globalSearch = AllowedFilter::callback('global', function ($query, $value) {
$query->where(function ($query) use ($value) {
Collection::wrap($value)->each(function ($value) use ($query) {
$query
->orWhere('name', 'LIKE', "%{$value}%")
->orWhere('email', 'LIKE', "%{$value}%");
});
});
});
$users = QueryBuilder::for(User::class)
->defaultSort('name')
->allowedSorts(['name', 'email', 'language_code'])
->allowedFilters(['name', 'email', 'language_code', $globalSearch])
->paginate()
->withQueryString();
return Inertia::render('Users/Index', [
'users' => $users,
])->table(function (InertiaTable $table) {
$table
->withGlobalSearch()
->defaultSort('name')
->column(key: 'name', searchable: true, sortable: true, canBeHidden: false)
->column(key: 'email', searchable: true, sortable: true)
->column(key: 'language_code', label: 'Language')
->column(label: 'Actions')
->selectFilter(key: 'language_code', label: 'Language', options: [
'en' => 'English',
'nl' => 'Dutch',
]);
}
}
You can install the package via either npm
or yarn
:
npm install @protonemedia/inertiajs-tables-laravel-query-builder --save
yarn add @protonemedia/inertiajs-tables-laravel-query-builder
Add the repository path to the content
array of your Tailwind configuration file. This ensures that the styling also works on production builds.
module.exports = {
content: [
'./node_modules/@protonemedia/inertiajs-tables-laravel-query-builder/**/*.{js,vue}',
]
}
To use the Table
component and all its related features, you must import the Table
component and pass the users
data to the component.
<script setup>
import { Table } from "@protonemedia/inertiajs-tables-laravel-query-builder";
defineProps(["users"])
</script>
<template>
<Table :resource="users" />
</template>
The resource
property automatically detects the data and additional pagination meta data. You may also pass this manually to the component with the data
and meta
properties:
<template>
<Table :data="users.data" :meta="users.meta" />
</template>
If you want to manually render the table, like in v1 of this package, you may use the head
and body
slot. Additionally, you can still use the meta
property to render the paginator.
<template>
<Table :meta="users">
<template #head>
<tr>
<th>User</th>
</tr>
</template>
<template #body>
<tr
v-for="(user, key) in users.data"
:key="key"
>
<td>{{ user.name }}</td>
</tr>
</template>
</Table>
</template>
The Table
has some additional properties to tweak its front-end behaviour.
<template>
<Table
:striped="true"
:prevent-overlapping-requests="false"
:input-debounce-ms="1000"
:preserve-scroll="true"
/>
</template>
Property | Description | Default |
---|---|---|
striped | Adds a striped layout to the table. | false |
preventOverlappingRequests | Cancels a previous visit on new user input to prevent an inconsistent state. | true |
inputDebounceMs | Number of ms to wait before refreshing the table on user input. | 350 |
preserveScroll | Configures the Scroll preservation behavior. You may also pass table-top to this property to scroll to the top of the table on new data. |
false |
When using auto-fill, you may want to transform the presented data for a specific column while leaving the other columns untouched. For this, you may use a cell template. This example is taken from the Example Controller above.
<template>
<Table :resource="users">
<template #cell(actions)="{ item: user }">
<a :href="`/users/${user.id}/edit`">
Edit
</a>
</template>
</Table>
</template>
You may want to use more than one table component per page. Displaying the data is easy, but using features like filtering, sorting, and pagination requires a slightly different setup. For example, by default, the page
query key is used for paginating the data set, but now you want two different keys for each table. Luckily, this package takes care of that and even provides a helper method to support Spatie's query package. To get this to work, you need to name your tables.
Let's take a look at Spatie's QueryBuilder
. In this example, there's a table for the companies and a table for the users. We name the tables accordingly. So first, call the static updateQueryBuilderParameters
method to tell the package to use a different set of query parameters. Now, filter
becomes companies_filter
, column
becomes companies_column
, and so forth. Secondly, change the pageName
of the database paginator.
InertiaTable::updateQueryBuilderParameters('companies');
$companies = QueryBuilder::for(Company::query())
->defaultSort('name')
->allowedSorts(['name', 'email'])
->allowedFilters(['name', 'email'])
->paginate(pageName: 'companiesPage')
->withQueryString();
InertiaTable::updateQueryBuilderParameters('users');
$users = QueryBuilder::for(User::query())
->defaultSort('name')
->allowedSorts(['name', 'email'])
->allowedFilters(['name', 'email'])
->paginate(pageName: 'usersPage')
->withQueryString();
Then, we need to apply these two changes to the InertiaTable
class. There's a name
and pageName
method to do so.
return Inertia::render('TwoTables', [
'companies' => $companies,
'users' => $users,
])->table(function (InertiaTable $inertiaTable) {
$inertiaTable
->name('users')
->pageName('usersPage')
->defaultSort('name')
->column(key: 'name', searchable: true)
->column(key: 'email', searchable: true);
})->table(function (InertiaTable $inertiaTable) {
$inertiaTable
->name('companies')
->pageName('companiesPage')
->defaultSort('name')
->column(key: 'name', searchable: true)
->column(key: 'address', searchable: true);
});
Lastly, pass the correct name
property to each table in the Vue template. Optionally, you may set the preserve-scroll
property to table-top
. This makes sure to scroll to the top of the table on new data. For example, when changing the page of the second table, you want to scroll to the top of the table, instead of the top of the page.
<script setup>
import { Table } from "@protonemedia/inertiajs-tables-laravel-query-builder";
defineProps(["companies", "users"])
</script>
<template>
<Table
:resource="companies"
name="companies"
preserve-scroll="table-top"
/>
<Table
:resource="users"
name="users"
preserve-scroll="table-top"
/>
</template>
You can override the default pagination translations with the setTranslations
method. You can do this in your main JavaScript file:
import { setTranslations } from "@protonemedia/inertiajs-tables-laravel-query-builder";
setTranslations({
next: "Next",
no_results_found: "No results found",
of: "of",
per_page: "per page",
previous: "Previous",
results: "results",
to: "to"
});
The Table.vue
has several slots that you can use to inject your own implementations.
Slot | Description |
---|---|
tableFilter | The location of the button + dropdown to select filters. |
tableGlobalSearch | The location of the input element that handles the global search. |
tableReset | The location of the button that resets the table. |
tableAddSearchRow | The location of the button + dropdown to add additional search rows. |
tableColumns | The location of the button + dropdown to toggle columns. |
tableSearchRows | The location of the input elements that handle the additional search rows. |
tableWrapper | The component that wraps the table element, handling overflow, shadow, padding, etc. |
table | The actual table element. |
head | The location of the table header. |
body | The location of the table body. |
pagination | The location of the paginator. |
Each slot is provided with props to interact with the parent Table
component.
<template>
<Table>
<template v-slot:tableGlobalSearch="slotProps">
<input
placeholder="Custom Global Search Component..."
@input="slotProps.onChange($event.target.value)"
/>
</template>
</Table>
</template>
A huge Laravel Dusk E2E test-suite can be found in the app
directory. Here you'll find a Laravel + Inertia application.
cd app
cp .env.example .env
composer install
npm install
npm run production
touch database/database.sqlite
php artisan migrate:fresh --seed
php artisan dusk:chrome-driver
php artisan serve
php artisan dusk
addColumn
method has been renamed to column
.addFilter
method has been renamed to selectFilter
.addSearch
method has been renamed to searchInput
.addColumns
and addSearchRows
methods have been removed.InteractsWithQueryBuilder
mixin has been removed and is no longer needed.Table
component no longer needs the filters
, search
, columns
, and on-update
properties.thead
or tbody
slot, you need to provide the styling manually.thead
, the showColumn
method has been renamed to show
.setTranslations
method is no longer part of the Pagination
component, but should be imported.Please see CHANGELOG for more information what has changed recently.
Please see CONTRIBUTING for details.
Laravel Analytics Event Tracking
: Laravel package to easily send events to Google Analytics.Laravel Blade On Demand
: Laravel package to compile Blade templates in memory.Laravel Cross Eloquent Search
: Laravel package to search through multiple Eloquent models.Laravel Eloquent Scope as Select
: Stop duplicating your Eloquent query scopes and constraints in PHP. This package lets you re-use your query scopes and constraints by adding them as a subquery.Laravel Eloquent Where Not
: This Laravel package allows you to flip/invert an Eloquent scope, or really any query constraint.Laravel FFMpeg
: This package provides an integration with FFmpeg for Laravel. The storage of the files is handled by Laravel's Filesystem.Laravel Form Components
: Blade components to rapidly build forms with Tailwind CSS Custom Forms and Bootstrap 4. Supports validation, model binding, default values, translations, includes default vendor styling and fully customizable!Laravel Mixins
: A collection of Laravel goodies.Laravel Verify New Email
: This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.Laravel Paddle
: Paddle.com API integration for Laravel with support for webhooks/events.Laravel WebDAV
: WebDAV driver for Laravel's Filesystem.If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.