abisetra/livewire-datatables

使用 Laravel、Livewire、Tailwind CSS 和 Alpine JS 的高级数据表格

维护者

详细信息

github.com/abisetra/livewire-datatables

主页

源代码

安装: 2

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 259

1.0.0 2023-06-23 20:53 UTC

Requires

Requires (Dev)

MIT d2d2d1ea64384e40a3bbc94af9c490d81687832a

  • Mark Salmon <mark.salmon.woop@mediconesystems.com>
  • Shane Burrell <shane.woop@shaneburrell.com>
  • Herbert Maschke <thyseus.woop@pm.me>

phplaravellivewire

This package is auto-updated.

Last update: 2024-09-23 23:30:03 UTC

README

Latest Version on Packagist Total Downloads

特性

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

实时演示应用

演示应用仓库

screenshot

要求

安装

您可以通过 composer 安装此包

composer require mediconesystems/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 的数组

列

可以使用以下任何静态方法构建列，然后使用流畅的方法链分配其属性。还有其他特定类型的 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('NAME')即可实现。您可以通过表的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为真且可用会话值）时，它将覆盖默认过滤器。

在下面的示例中，表将默认按deleted_at列是假值的行进行过滤。如果用户有针对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(),

            ...
        ];
    }
}

复杂查询构建器

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

特性

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

image

持久化查询（需要 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 方法，为不同的表格提供不同的模板。

致谢和影响