amirami/livewire-datatables

Livewire DataTables components for back-end. Modular, easy to use, with tons of features.

dev-master 2021-09-28 12:26 UTC

This package is auto-updated.

Last update: 2022-05-28 14:12:57 UTC


README

GitHub Tests Action Status Total Downloads Latest Version on Packagist GitHub Code Style Action Status

Livewire DataTables components for back-end. Modular, easy to use, with tons of features.

Inspired by Caleb's Livewire Screencasts, dedicated to my friend Bardh.

Installation

You can install the package via composer:

composer require amirami/livewire-datatables

You can publish the config file with:

php artisan vendor:publish --provider="Amirami\LivewireDataTables\LivewireDataTablesServiceProvider" --tag="livewire-datatables-config"

This is the contents of the published config file:

return [

    'multi_column_sorting' => false,

    'row_caching' => false,

];

This means that by default these two options are disabled. But you can enable them for individual components.

Usage

After creating your Livewire component, extend the component class with Amirami\LivewireDataTables\DataTable. The DataTable abstract class will ask you to implement getQueryProperty method. This is a computed property in Livewire which needs to return and instance of Illuminate\Database\Eloquent\Builder or \Illuminate\Database\Eloquent\Relations\Relation.

This is the part where you will build the base of your query, with filters.

namespace App\Http\Livewire;

use App\Models\Post;
use Amirami\LivewireDataTables\DataTable;
use Illuminate\Database\Eloquent\Builder;

class PostsIndex extends DataTable
{
    public function getQueryProperty(): Builder
    {
        return Post::query();
    }

    public function render()
    {
        $posts = $this->entries;

        return view('livewire.posts-index', compact('posts'));
    }
}

This is the most basic component without any datatable features. Although it is totally fine to use the datatable without any features, it kinda beats the purpose of this package. Now let's get onto the many features this package provides.

Pagination

Pagination offers exactly the same features as Livewire's default one. It actually extends it. The only reason you'll have to use the pagination provided by this package is because Livewire's default one doesn't play nice with our other features.

namespace App\Http\Livewire;

use Amirami\LivewireDataTables\DataTable;
use Amirami\LivewireDataTables\Traits\WithPagination;

class PostsIndex extends DataTable
{
    use WithPagination;
}

You can configure how many result you want to see per page as well. If not defined the paginator will pull the default number from the model class.

namespace App\Http\Livewire;

use Amirami\LivewireDataTables\DataTable;
use Amirami\LivewireDataTables\Traits\WithPagination;

class PostsIndex extends DataTable
{
    use WithPagination;
    
    // As a property.
    public $perPage = 20;
    
    // Or as a method.
    public function getPerPage(): ?int
    {
        return 42;
    }
}

For everything else about pagination check out the Livewire's official documentation.

Searching

If you want to use rows searching you have to use WithSearching trait, bind an input to a component property and define searchable columns. Consider the rest handled. This is how easy it is:

namespace App\Http\Livewire;

use Amirami\LivewireDataTables\DataTable;
use Amirami\LivewireDataTables\Traits\WithSearching;

class PostsIndex extends DataTable
{
    use WithSearching;
    
    public $searchableColumns = [
        'title',
        'content',
    ];
    
    public function render()
    {
        $posts = $this->entries;

        return view('livewire.posts-index', compact('posts'));
    }
}
<input wire:model="search" type="text">

<table>
    <thead>
        <tr>
            <th>Title</th>
            <th>Excerpt</th>
            <th>Author</th>
            <th>Status</th>
        </tr>
    </thead>
    <tbody>
        @foreach($posts as $post)
            <tr>
                <th>{{ $post->title }}</th>
                <th>{{ $post->excerpt }}</th>
                <th>{{ $post->user->name }}</th>
                <th>{{ $post->status() }}</th>
            </tr>
        @endforeach
    </tbody>
</table>

Sorting

Filtering

Row Caching

Planned Features

  • Searching, sorting and filtering by relationship fields
  • Bulk Actions
  • Row Grouping
  • Front-end components (will most-likely be a separate package)

Showcase

Check out cool datatables built with livewire-datatables here, and don't forget to share your own 🙌.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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