robinflyhigh/livewire-datatables

维护者

详细信息

github.com/robinflyhigh/livewire-datatables

主页

源代码

安装量: 1,471

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 259

v0.6.8 2021-09-23 08:18 UTC

Requires

Requires (Dev)

MIT b49295b79cd71730692a476dc7145f27729a6a2b

  • Mark Salmon <mark.salmon.woop@mediconesystems.com>

mediconesystemslivewire-datatables

This package is auto-updated.

Last update: 2024-09-23 14:47:04 UTC

README

Latest Version on Packagist Total Downloads

特性

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

实时演示应用

演示应用仓库

screenshot

需求

安装

您可以通过 composer 安装此包

composer require mediconesystems/livewire-datatables

可选

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

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

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

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

一些内置的动态组件使用 Alpine JS，所以要消除页面加载时的闪烁，请确保您在 CSS 中有

[x-cloak] {
    display: none;
}

某个地方

基本用法

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

<livewire:datatable model="App\User" />

...

模板语法

  • 通过向组件传递额外的属性，有许多方法可以修改表格
<livewire:datatable
    model="App\User"
    include="id, name, dob, created_at"
    dates="dob"
/>

属性

组件语法

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

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

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

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

php artisan 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),

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

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

列方法

监听器

组件将监听 refreshLivewireDatatable 事件，这使得您可以从外部组件刷新表格。

Eloquent 列名

可以使用正常的 eloquent 点符号包含 Eloquent 关系中的列，例如 planet.name，Livewire Datatables 将自动添加必要的表连接来包含该列。如果关系是 'many' 类型（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'),

自定义列名

您仍然可以完全控制您的表格，您可以使用任何查询定义一个 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);
            }),

            ...
    }
}

视图

您可以将列的输出直接传递到单独的 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 逻辑组合规则和规则组。
  • 在界面中拖放规则。

image

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

  • 将 $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 Livewire Datatable
{
    ...

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

致谢与影响