basry/filament-modules

filamentphp 对 nwidart/laravel-modules 的支持

3.x-dev 2024-01-27 01:25 UTC

This package is auto-updated.

Last update: 2024-09-27 03:01:55 UTC


README

Tests Styling Laravel v9.x Filament v3.x PHP 8.1 Packagist

模块是 FilamentPHP 插件,用于简化与 nwidart/laravel-modules 的集成

注意:这些文档适用于 v3 版本,仅支持 Filament 3。如果您使用的是 Filament v2,请在此处查看文档以开始使用。

安装

要求

  1. Filament >= 3
  2. PHP >= 8.1
  3. Laravel >= 9.0
  4. Livewire >= 3.0
  5. nwidart/laravel-modules >=10.0

安装

composer require coolsam/modules

使用方法

在本指南中,我们将使用 博客模块 作为示例

创建您的 Laravel 模块

如果您要工作的模块不存在,请使用 nwidart/laravel-modules 创建它

php artisan module:make Blog # Create the blog module

在您的模块内生成一个新面板

php artisan module:make-filament-panel admin Blog # php artisan module:make-filament-panel [id] [module]

如果没有传递任何参数,命令将交互式地请求每个参数。在本例中,如果传递的 Panel ID 是 admin 且模块是 blog,则命令将生成一个 ID 为 blog::admin 的面板。此 ID 应用于下一步生成资源、页面和小部件时。

像往常一样生成您的资源、页面和小部件,选择您刚刚创建的上面的面板。

从现在开始,像往常一样使用 filament 生成 资源页面小部件。务必指定之前生成的 ID 的 --panel 选项。如果不传递 --panel 选项,命令将交互式地请求它。

# For each of these commands, the package will ask for the Model and Panel.
php artisan make:filament-resource
php artisan make:filament-page
php artisan make:filament-widget
# The Model and Panel arguments are passed inline
php artisan make:filament-resource Author blog::admin
php artisan make:filament-page Library blog::admin
php artisan make:filament-widget BookStats blog::admin

大功告成!对于生成的每个面板,您可以通过 module-path/panel-path(例如 blog/admin)导航到您的面板以及资源链接和页面链接。

测试

composer test

变更日志

请参阅 变更日志 了解最近的变化。

贡献

请参阅 贡献指南 获取详细信息。

安全漏洞

请查阅 我们的安全策略 了解如何报告安全漏洞。

致谢

许可

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