README

功能

• 使用模型或查询构建器提供数据
• 使用预设或自定义回调修改和格式化列
• 使用列或计算列排序数据
• 使用布尔值、时间、日期、选择或自由文本进行过滤
• 使用复杂查询构建器创建复杂的组合过滤器
• 显示/隐藏列
• 列组
• 支持批量操作（批量）

实时演示应用程序

演示应用程序仓库

要求

• Laravel 7, 8, 9或10
• Livewire
• Tailwind
• Alpine JS

安装

您可以通过composer安装此包

composer require arm092/livewire-datatables

如果您使用laravel 9，首先执行

composer require psr/simple-cache:^1.0 maatwebsite/excel

可选

您不需要这样做，但如果您喜欢，您可以发布配置文件和blade模板资源

php artisan vendor:publish --provider="Mediconesystems\LivewireDatatables\LivewireDatatablesServiceProvider"

这将使您能够修改blade视图并应用自己的样式，数据表的视图将发布到resources/livewire/datatables。配置文件包含整个应用程序中使用的默认时间和日期格式

• 如果您在项目中使用Purge CSS，这将很有用，以确保所有livewire-datatables类都被包括在内

许多内置的动态组件都使用了Alpine JS，因此为了在页面加载时移除闪烁，请确保您的CSS中包含以下内容

[x-cloak] {
    display: none;
}

某个地方

基本用法

• 在blade视图中使用livewire-datatable组件，并传入一个模型

...

<livewire:datatable model="App\User" name="all-users" />

...

模板语法

• 有多种方法可以通过向组件传递额外的属性来修改表格

<livewire:datatable
    model="App\User"
    name="users"
    include="id, name, dob, created_at"
    dates="dob"
/>

注意：请注意，在同一个页面上有多个数据表或在不同页面上有多个相同类型的数据表需要为每个数据表分配一个唯一的name属性，以防止它们相互冲突，如上面的示例所示。

属性

组件语法

创建一个扩展Mediconesystems\LivewireDatatables\LivewireDatatable的livewire组件

php artisan make:livewire-datatable foo --> 'app/Http/Livewire/Foo.php'

php artisan make:livewire-datatable tables.bar --> 'app/Http/Livewire/Tables/Bar.php'

通过声明公共属性$model 或 公共方法builder()，该方法返回一个Illuminate\Database\Eloquent\Builder实例来提供数据源

php artisan make:livewire-datatable users-table --model=user --> 'app/Http/Livewire/UsersTable.php' with public $model = User::class

声明一个公共方法columns，它返回一个包含一个或多个Mediconesystems\LivewireDatatables\Column的数组

列

列可以使用以下任何静态方法构建，然后使用流畅的方法链分配它们的属性。还有额外的特定类型的列；NumberColumn、DateColumn、TimeColumn，使用正确的类型将启用特定类型的格式化和过滤

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')
                ->group('group1')
                ->searchable()
                ->hideable()
                ->filterable(),

            Column::name('planet.name')
                ->label('Planet')
                ->group('group1')
                ->searchable()
                ->hideable()
                ->filterable($this->planets),

            // Column that counts every line from 1 upwards, independent of content
            Column::index($this);

            DateColumn::name('dob')
                ->label('DOB')
                ->group('group2')
                ->filterable()
                ->hide(),

            (new LabelColumn())
                ->label('My custom heading')
                ->content('This fixed string appears in every row'),

            NumberColumn::name('dollars_spent')
                ->enableSummary(),
        ];
    }
}

列方法

监听器

组件将监听refreshLivewireDatatable事件，这允许您从外部组件刷新表格。

Eloquent列名

使用Eloquent关系中的列可以通过正常的Eloquent点表示法来包含，例如：planet.name，Livewire Datatables将自动添加必要的表连接来包含该列。如果关系是“多”类型（《HasMany》、《BelongsToMany》、《HasManyThrough》）则Livewire Datatables将创建一个聚合子查询（这比连接和分组要高效得多。感谢@reinink）。默认情况下，聚合类型将是对数值列使用《count》对字符串列使用《group_concat》，但可以使用冒号分隔符来覆盖。

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'),

列组

当您有一个非常大的表格且有大量列时，可以创建“列组”，允许用户一次性切换整个组的可见性。在任意列中使用->group('名称')即可实现此功能。您可以通过表格的groupLabels属性来使用人类可读的标签和组翻译。

class GroupDemoTable extends LivewireDatatable
{
    public $groupLabels = [
         'group1' => 'app.translation_for_group_1'
         'group2' => 'app.translation_for_group_2'
    ];

public function columns()
{
    return [
        Column::name('planets.name')
            ->group('group1')
            ->label('Planet'),

        Column::name('planets.name')
            ->group('group2')
            ->label('Planet'),

汇总行

如果您需要汇总特定列的所有单元格，可以使用enableSummary()。

public function columns()
{
    return [
        Column::name('dollars_spent')
            ->label('Expenses in Dollar')
            ->enableSummary(),

        Column::name('euro_spent')
            ->label('Expenses in Euro')
            ->enableSummary(),

批量操作

如果您想要一次性对多个记录进行操作，可以在您的表格中使用buildActions()方法。

public function buildActions()
    {
        return [

            Action::value('edit')->label('Edit Selected')->group('Default Options')->callback(function ($mode, $items) {
                // $items contains an array with the primary keys of the selected items
            }),

            Action::value('update')->label('Update Selected')->group('Default Options')->callback(function ($mode, $items) {
                // $items contains an array with the primary keys of the selected items
            }),

            Action::groupBy('Export Options', function () {
                return [
                    Action::value('csv')->label('Export CSV')->export('SalesOrders.csv'),
                    Action::value('html')->label('Export HTML')->export('SalesOrders.html'),
                    Action::value('xlsx')->label('Export XLSX')->export('SalesOrders.xlsx')->styles($this->exportStyles)->widths($this->exportWidths)
                ];
            }),
        ];
    }

批量操作样式

如果您只想对批量操作下拉菜单进行一些小的样式调整，可以在此调整一些设置。

public function getExportStylesProperty()
    {
        return [
            '1'  => ['font' => ['bold' => true]],
            'B2' => ['font' => ['italic' => true]],
            'C'  => ['font' => ['size' => 16]],
        ];
    }

    public function getExportWidthsProperty()
    {
        return [
            'A' => 55,
            'B' => 45,
        ];
    }

固定记录

如果您想要让用户能够固定特定的记录以便进行比较等，可以使用CanPinRecords特质。请确保至少有一个复选框列，以便用户可以选择记录。

use Mediconesystems\LivewireDatatables\Traits\CanPinRecords;

class RecordTable extends LivewireDatatable
{
    use CanPinRecords;

    public $model = Record::class;

    public function columns()
    {
        return [
            Column::checkbox(),

            // ...

自定义列名

仍然可以完全控制您的表格，您可以使用任何查询定义一个builder方法，使用您自己的连接、分组等，然后使用正常的SQL语法命名您的列。

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`'),

        ...
}

回调

回调允许您在数据显示在表格之前进行任何更改。

• 回调在数据库查询的分页结果上执行，因此不应占用大量内存。
• 回调将接收所选列作为其参数。
• 以下是如何定义内联回调，或者作为Datatable类的公共方法，通过将名称作为字符串传递给回调方法的第二个参数来引用。
• 如果您想以不同的方式格式化导出的结果，请使用->exportCallback(Closure $callback)。

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;
            })->exportCallback(function ($dob, $signupDate), {
                return $age = $signupDate->diffInYears($dob);
            }),

            ...
    }
}

默认过滤器

如果您想在表格上应用默认过滤器，可以使用defaultFilters属性。`defaultFilter`应是一个包含列名和默认过滤器值的数组。当有持久过滤器（`$this->persistFilters`为true且会话值可用）时，它将覆盖默认过滤器。

在下面的示例中，表格默认将按deleted_at列的值为false的行进行筛选。如果用户为deleted_at列有持久过滤器，则默认过滤器将被忽略。

class CallbackDemoTable extends LivewireDatatable
{
    public $defaultFilters = [
        'deleted_at' => '0',
    ];

    public function builder()
    {
        return User::query()->withTrashed();
    }

    public function columns()
    {
        return [
            Column::name('id'),
            BooleanColumn::name('deleted_at')->filterable(),
        ];
    }
}

视图

您可以将列的输出直接导入到单独的blade视图模板中。

• 模板使用通常的Laravel视图辅助语法指定。
• 视图将接收列的值作为$value，以及整个查询行作为$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标记列。这使用上面的view()方法将数据传递到可以直接更新底层数据库数据的Alpine/Livewire组件。要求列使用标准Laravel命名定义column。以下是一个示例。可以使用上面的回调或视图方法构建更全面的具有验证等的自定义可编辑列。

class EditableTable extends LivewireDatatable
{

    public $model = User::class;

    public function columns()
    {
        return [
            Column::name('id')
                ->label('ID')
                ->linkTo('job', 6),

            Column::name('email')
                ->editable(),

            ...
        ];
    }
}

复杂查询构建器

只需将$complex = true添加到您的Datatable类中，所有可筛选列都将可用于复杂查询构建器。

功能

• 使用AND/OR逻辑组合规则和规则组
• 在界面中拖放规则

持久化查询（需要AlpineJS v3和$persist插件）

• 在您的类中添加$persistComplexQuery = true，查询将被存储在浏览器本地存储中。
• 默认情况下，本地存储的键将是类名。您可以通过设置公共属性$persistKey或覆盖Datatable类的getPersistKeyProperty()来提供自己的键。
• 例如：对于用户特定的持久化

public function getPersistKeyProperty()
{
    return Auth::id() . '-' . parent::getPersistKeyProperty();
}

保存查询

如果您想永久保存查询，您必须提供3个方法来添加、删除和检索您的保存查询，使用您喜欢的任何逻辑。

• public function saveQuery(String $name, Array $rules)
• public function deleteQuery(Int $id)
• public function getSavedQueries()

• 在您的保存和删除方法中，请确保发出updateSavedQueries livewire事件，并传递新的结果数组（请参见下面的示例）

示例

此示例显示使用属于用户的传统Laravel ComplexQuery模型保存查询

/* Migration */

class CreateComplexQueriesTable extends Migration
{
    public function up()
    {
        Schema::create('complex_queries', function (Blueprint $table) {
            $table->id();
            $table->unsignedInteger('user_id');
            $table->string('table');
            $table->json('rules');
            $table->string('name');
            $table->timestamps();
        });
    }
}


/* Model */

class ComplexQuery extends BaseModel
{
    protected $casts = ['rules' => 'array'];

    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

/* Datatable Class */

class TableWithSaving extends LivewireDatatable
{
    ...

    public function saveQuery($name, $rules)
    {
        Auth::user()->complex_queries()->create([
            'table' => $this->name,
            'name' => $name,
            'rules' => $rules
        ]);

        $this->emit('updateSavedQueries', $this->getSavedQueries());
    }

    public function deleteQuery($id)
    {
        ComplexQuery::destroy($id);

        $this->emit('updateSavedQueries', $this->getSavedQueries());
    }

    public function getSavedQueries()
    {
        return Auth::user()->complex_queries()->where('table', $this->name)->get();
    }

    ...
}

样式

我知道提供带有大量有偏见标记和样式的包并不酷。大多数其他包似乎都走过了通过将可选类作为参数或配置变量传递的道路。我的看法是，因为这只是blade与tailwind的结合，您可以发布模板并对它们进行任何您想做的事情 - 应该很明显Livewire和Alpine的移动部分在哪里。

有方法可以对行和单元格应用样式。rowClasses接收$row和laravel循环变量作为参数。cellClasses接收$row和$column

例如

public function rowClasses($row, $loop)
{
    return 'divide-x divide-gray-100 text-sm text-gray-900 ' . ($this->rowIsSelected($row) ? 'bg-yellow-100' : ($row->{'car.model'} === 'Ferrari' ? 'bg-red-500' : ($loop->even ? 'bg-gray-100' : 'bg-gray-50')));
}

public function cellClasses($row, $column)
{
    return 'text-sm ' . ($this->rowIsSelected($row) ? ' text-gray-900' : ($row->{'car.model'} === 'Ferrari' ? ' text-white' : ' text-gray-900'));
}

您可以通过更改配置文件livewire-datatables.php中的default_classes来更改由rowClasses和cellClasses方法应用的默认CSS类。

您还可以覆盖您表格类的render方法，为不同的表格提供不同的模板。

致谢和影响

• Laravel
• Laravel Livewire
• Tailwind CSS
• AlpineJS
• coryrose1的livewire-tables
• kdion4891的laravel-livewire-datatables
• Jonathan Reinink的Eloquent课程