Github GitHub - MedicOneSystems/livewire-datatables: Advanced datatables using L...
source link: https://github.com/MedicOneSystems/livewire-datatables
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
Livewire Datatables
Features
- Use a model or query builder to supply data
- Mutate and format columns using preset or custom callbacks
- Sort data using column or computed column
- Filter using booleans, times, dates, selects or free text
- Show / hide columns
Live Demo App
Demo App Repo
Requirements
Installation
You can install the package via composer:
composer require mediconesystems/livewire-datatables
Optional
You don't need to, but if you like you can publish the config file and blade template assets:
php artisan vendor:publish
This will enable you to modify the blade views and apply your own styling, the datatables views will be published to resources/livewire/datatables. The config file contains the default time and date formats used throughout
- This can be useful if you're using Purge CSS on your project, to make sure all the livewire-datatables classes get included
Several of the built-in dynamic components use Alpine JS, so to remove flickers on page load, make sure you have
[x-cloak] { display: none; }
somewhere in your CSS
Basic Usage
- Use the
livewire-datatable
component in your blade view, and pass in a model:
... <livewire:datatable model="App\User" /> ...
Template Syntax
- There are many ways to modify the table by passing additional properties into the component:
<livewire:datatable model="App\User" include="id, name, dob, created_at" dates="dob" />
Props
Property
Arguments
Result
Example
model
String full model name
Define the base model for the table
model="App\Post"
include
String|Array of column definitions
specify columns to be shown in table, label can be specified by using | delimter
```include="name, email, dob
exclude
String|Array of column definitions
columns are excluded from table
:exclude="['created_at', 'updated_at']"
hide
String|Array of column definitions
columns are present, but start hidden
hidden="email_verified_at"
dates
String|Array of column definitions [ and optional format in | delimited string]
column values are formatted as per the default date format, or format can be included in string with | separator
```:dates="['dob
times
String|Array of column definitions [optional format in | delimited string]
column values are formatted as per the default time format, or format can be included in string with | separator
```'bedtime
searchable
String|Array of column names
Defines columns to be included in global search
searchable="name, email"
sort
String of column definition [and optional 'asc' or 'desc' (default: 'desc') in | delimited string]
Specifies the column and direction for initial table sort. Default is column 0 descending
```sort="name
hide-header
Boolean default: false
The top row of the table including the column titles is removed if this is true
hide-pagination
Boolean default: false
Pagination controls are removed if this is true
per-page
Integer default: 10
Number of rows per page
per-page="20"
exportable
Boolean default: false
Allows table to be exported
<livewire:datatable model="App/Post" exportable />
hideable
String
gives ability to show/hide columns, accepts strings 'inline', 'buttons', or 'select'
<livewire:datatable model="App/Post" hideable="inline" />
beforeTableSlot
String
blade view to be included immediately before the table in the component, which can therefore access public properties
afterTableSlot String blade view to be included immediately after the table in the component, which can therefore access public properties demo
Component Syntax
Create a livewire component that extends Mediconesystems\LivewireDatatables\LivewireDatatable
php artisan livewire:datatable foo
--> 'app/Http/Livewire/Foo.php'
php artisan livewire:datatable tables.bar
--> 'app/Http/Livewire/Tables/Bar.php'
Provide a datasource by declaring public property $model
OR public method builder()
that returns an instance of Illuminate\Database\Eloquent\Builder
php artisan livewire:datatable users-table --model=user
--> 'app/Http/Livewire/UsersTable.php' withpublic $model = User::class
Declare a public method columns
that returns an array containing one or more Mediconesystems\LivewireDatatables\Column
Columns
Columns can be built using any of the static methods below, and then their attributes assigned using fluent method chains.
There are additional specific types of Column; NumberColumn
, DateColumn
, TimeColumn
, using the correct one for your datatype will enable type-specific formatting and filtering:
class ComplexDemoTable extends LivewireDatatable { public function builder() { return User::query(); } public function columns() { return [ NumberColumn::name('id') ->label('ID') ->linkTo('job', 6), BooleanColumn::name('email_verified_at') ->label('Email Verified') ->format() ->filterable(), Column::name('name') ->defaultSort('asc') ->searchable() ->filterable(), Column::name('planet.name') ->label('Planet') ->searchable() ->filterable($this->planets), DateColumn::name('dob') ->label('DOB') ->filterable() ->hide() ]; } }
Column Methods
Method
Arguments
Result
Example
static name
String $column
Builds a column from column definition, which can be eith Eloquent or SQL dot notation (see below)
Column::name('name')
static raw
String $rawSqlStatement
Builds a column from raw SQL statement. Must include "... AS alias"
Column::raw("CONCAT(ROUND(DATEDIFF(NOW(), users.dob) / planets.orbital_period, 1) AS `Native Age`")
static callback
Array|String $columns, Closure|String $callback
Passes the columns from the first argument into the callback to allow custom mutations. The callback can be a method on the table class, or inline
(see below)
static scope
String $scope, String $alias
Builds a column from a scope on the parent model
Column::scope('selectLastLogin', 'Last Login')
static delete
[String $primaryKey default: 'id']
Adds a column with a delete button, which will call $this->model::destroy($primaryKey)
Column::delete()
static checkbox
[String $column default: 'id']
Adds a column with a checkbox. The component public property $selected
will contain an array of the named column from checked rows,
Column::checkbox()
label
String $name
Changes the display name of a column
Column::name('id')->label('ID)
format
[String $format]
Formats the column value according to type. Dates/times will use the default format or the argument
Column::name('email_verified_at')->filterable(),
hide
Marks column to start as hidden
Column::name('id')->hidden()
sortBy
String|Expression $column
Changes the query by which the column is sorted
Column::name('dob')->sortBy('DATE_FORMAT(users.dob, "%m%d%Y")'),
truncate
[Integer $length (default: 16)]Truncates column to $length and provides full-text in a tooltip. Uses view('livewire-datatables::tooltip)
Column::name('biography)->truncate(30)
linkTo
String $model, [Integer $pad]
Replaces the value with a link to "/$model/$value"
. Useful for ID columns. Optional zero-padding. Uses view('livewire-datatables::link)
Column::name('id')->linkTo('user')
round
[Integer $precision (default: 0)]
Rounds value to given precision
Column::name('age')->round()
defaultSort
[String $direction (default: 'desc')]
Marks the column as the default search column
Column::name('name')->defaultSort('asc')
searchable
Includes the column in the global search
Column::name('name')->searchable()
filterable
[Array $options], [String $filterScope]
Adds a filter to the column, according to Column type. If an array of options is passed it wil be used to populate a select input. If the column is a scope column then the name of the filter scope muyst also be passed
Column::name('allegiance')->filterable(['Rebellion', 'Empire'])
view
String $viewName
Passes the column value, whole row of values, and any additional parameters to a view template
(see below)
editable
Marks the column as editable (see below) alignCenter
Center-aligns column header and contents
Column::delete()->alignCenter()
alignCenter
Right-aligns column header and contents
Column::delete()->alignRight()
editable
Marks the column as editable (see below) excludeFromExport
Prevents the column as editable
Column::name('email')->exclude
Listener
The component will listen for the refreshLivewireDatatable
event, which allows you to refresh the table from external components.
Eloquent Column Names
Columns from Eloquent relations can be included using the normal eloquent dot notation, eg. planet.name
, Livewire Datatables will automatically add the necessary table joins to include the column. If the relationship is of a 'many' type (HasMany
, BelongsToMany
, HasManyThrough
) then Livewire Datatables will create an aggregated subquery (which is much more efficient than a join and group. Thanks @reinink). By default, the aggregate type will be count
for a numeric column and group_concat
for a string column, but this can be over-ridden using a colon delimeter;
NumberColumn::name('students.age:sum')->label('Student Sum'), NumberColumn::name('students.age:avg')->label('Student Avg'), NumberColumn::name('students.age:min')->label('Student Min'), NumberColumn::name('students.age:max')->label('Student Max'),
Custom column names
It is still possible to take full control over your table, you can define a builder
method using whatever query you like, using your own joins, groups whatever, and then name your columns using your normal SQL syntax:
public function builder() { return User::query() ->leftJoin('planets', 'planets.id', 'users.planet_id') ->leftJoin('moons', 'moons.id', 'planets.moon_id') ->groupBy('users.id'); } public function columns() { return [ NumberColumn::name('id') ->filterable(), Column::name('planets.name') ->label('Planet'), Column::raw('GROUP_CONCAT(planets.name SEPARATOR " | ") AS `Moon`'), ... }
Callbacks
Callbacks give you the freedom to perform any mutations you like on the data before displaying in the table.
- The callbacks are performed on the paginated results of the database query, so shouldn't use a ton of memory
- Callbacks will receive the chosen columns as their arguments.
- Callbacks can be defined inline as below, or as public methods on the Datatable class, referenced by passing the name as a string as the second argument to the callback method.
class CallbackDemoTable extends LivewireDatatable { public model = User::class public function columns() { return [ Column::name('users.id'), Column::name('users.dob')->format(), Column::callback(['dob', 'signup_date'], function ($dob, $signupDate) { $age = $signupDate->diffInYears($dob); return $age > 18 ? '<span class="text-red-500">' . $age . '</span>' : $age; }), ... } }
Views
You can specify that a column's output is piped directly into a separate blade view template.
- Template is specified using ususal laravel view helper syntax
- Views will receive the column's value as
$value
, and the whole query row as$row
class CallbackDemoTable extends LivewireDatatable { public model = User::class public function columns() { return [ Column::name('users.id'), Column::name('users.dob')->view('tables.dateview'), Column::name('users.signup_date')->format(), ]; }
'tables/dateview.blade.php' <span class="mx-4 my-2 bg-pink-500"> <x-date-thing :value="$value" /> </span>
Editable Columns
You can mark a column as editable using editable
This uses the view()
method above to pass the data into an Alpine/Livewire compnent that can directly update the underlying database data. Requires the column to have column
defined using standard Laravel naming. This is included as an example. Much more comprehensive custom editable columns with validation etc can be built using the callback or view methods above.
class EditableTable extends LivewireDatatable { public $model = User::class; public function columns() { return [ Column::name('id') ->label('ID') ->linkTo('job', 6), Column::name('email') ->editable(), ... ]; } }
Styling
I know it's not cool to provide a package with tons of opionated markup and styling. Most other packages seem to have gone down the route of passing optional classes around as arguments or config variables. My take is that because this is just blade with tailwind, you can publish the templates and do whatever you like to them - it should be obvious where the Livewire and Alpine moving parts are.
You could also override the render method in your table's class to provide different templates for different tables.
Credits and Influences
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK