tiknil/wire-table

Laravel 扩展 Livewire 的包,用于轻松创建有用的表格

1.5.2 2024-06-07 08:20 UTC

This package is auto-updated.

Last update: 2024-09-07 09:04:17 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

本项目的目标是提供一个有用的样板代码,为构建后台表格提供合理的默认设置,同时允许轻松定制。

安装

wire-table 需要 PHP >= 8.1 和 Laravel >= 10.0

composer require livewire/livewire:^3.0 tiknil/wire-table

注意

从 v1.0.0 版本开始,wire-table 需要 livewire 3.0。如果您需要支持 livewire 2,请使用 v0.3.2。

可选 您可以发布 wire-table 文件以进行进一步定制

php artisan vendor:publish --tag=wiretable:config # Config file
php artisan vendor:publish --tag=wiretable:views  # Blade views
php artisan vendor:publish --tag=wiretable:lang   # Lang translation files

使用方法

使用 make:wiretable 命令创建一个新的组件

php artisan make:wiretable UsersTable

UsersTable 类将被创建在您的 app/Livewire 文件夹中。

基本表格

class UsersTable extends WireTable
{
    public function query(): Builder
    {
        return User::query();
    }

    public function columns(): array
    {
        return [
            Column::create(
                label: __('backend.created_at'),
                key: 'created_at',
                sort: true
            ),
            Column::create(
                label: __('backend.name'),
                key: 'name',
                sort: true
            ),
            Column::create(
                label: __('backend.email'),
                key: 'email',
                sort: true
            ),
        ];
    }
}

将其包含在您的 blade 文件中

<livewire:users-table />

请记住,在每个您将使用它的页面上包含 livewire 的 JavaScript 和 CSS

表格仅仅是 Livewire 组件,所以这里适用 官方 Livewire 文档

特性

请参阅 docs 文件夹 以获取完整文档。

快速链接

变更日志

请参阅 CHANGELOG 了解最近更改了什么。

贡献

请参阅 CONTRIBUTING 了解详情。

安全

如果您发现任何安全相关的问题,请通过电子邮件 balduzzi.giorgio@tiknil.com 报告,而不是使用问题跟踪器。

致谢

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 以获取更多信息。

本包使用 Laravel Package Boilerplate 生成,遵循 laravelpackage.com 文档。