arashsheyda/livewire-datatables

维护者

详情

github.com/arashsheyda/livewire-datatables

主页

源代码

安装: 4

依赖: 0

建议者: 0

安全: 0

星标: 2

关注者: 0

分支: 259

v0.9.2 2022-03-23 19:37 UTC

Requires

Requires (Dev)

MIT 0b1068ce45f942d4b84f80610efbe69f03386523

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

mediconesystemslivewire-datatables

This package is auto-updated.

Last update: 2024-09-27 19:07:22 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;
}

somewhere in your CSS

基本用法

  • 在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 trait。请确保至少有一个复选框列，以便用户可以选择记录。

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);
            }),

            ...
    }
}

视图

您可以将列的输出直接传入单独的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();
}

保存查询

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

  • 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 类。

您还可以在表的类中覆盖渲染方法，为不同的表提供不同的模板。

致谢和影响