t-raven/livewire-datatables

使用Laravel、Livewire、Tailwind CSS和Alpine JS的高级数据表，解决固定587问题

维护者

详细信息

github.com/t-raven/livewire-datatables

主页

源代码

安装: 1,683

依赖者: 0

建议者: 0

安全: 0

星级: 0

关注者: 0

分支: 258

1.0.2 2023-11-02 12:09 UTC

Requires

Requires (Dev)

MIT a2799c3c1e412302cae7654848da0e6df90ebcc2

  • 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-08-31 00:52:10 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的数组

列

可以使用以下静态方法中的任何一个来构建列，然后使用流畅的方法链为其分配属性。还有其他特定的列类型：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属性。默认过滤器应该是一个包含列名和要使用的默认过滤器值的数组。如果可用持久过滤器（$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(),

            ...
        ];
    }
}

复杂查询构建器

只需在您的 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 方法，为不同的表格提供不同的模板。

致谢和影响