shebaoting / modules
支持filamentphp中的nwidart/laravel-modules
Requires
- php: ^8.1
- filament/filament: ^3.0.0-beta
- illuminate/contracts: ^11.0
- nwidart/laravel-modules: ^10.0
- spatie/laravel-package-tools: ^1.14.0
Requires (Dev)
- laravel/pint: ^1.0
- nunomaduro/collision: ^7.9
- orchestra/testbench: ^8.0
- pestphp/pest: ^2.0
- pestphp/pest-plugin-arch: ^2.0
- pestphp/pest-plugin-laravel: ^2.0
- spatie/laravel-ray: ^1.26
This package is not auto-updated.
Last update: 2024-09-21 14:39:08 UTC
README
Modules是FilamentPHP插件,可以轻松集成nwidart/laravel-modules
注意:这些文档是为v3版本编写的,它仅支持Filament 3。如果您使用的是Filament v2,请参阅[此处](https://github.com/savannabits/filament-modules/tree/main#readme)的文档以开始使用。
安装
需求
- Filament >= 3
- PHP >= 8.1
- Laravel >= 9.0
- Livewire >= 3.0
- nwidart/laravel-modules >=10.0
安装
- 确保您已安装并配置了Laravel Modules(遵循这些说明)
- 确保您已安装并配置了Filamentphp(遵循这些说明)
- 现在您可以通过composer安装此包
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]
如果没有传递任何两个参数,则命令将交互式地请求它们。在本例中,如果传递的面板ID是admin
且模块是blog,则命令将生成ID为blog::admin
的面板。在下一步生成资源、页面和小部件时,应使用此ID。此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
变更日志
请参阅[变更日志](https://github.com/shebaoting/filament-modules/blob/HEAD/CHANGELOG.md)以获取有关最近更改的更多信息。
贡献
请参阅[贡献指南](https://github.com/shebaoting/filament-modules/blob/HEAD/CONTRIBUTING.md)以获取详细信息。
安全漏洞
请查看[我们的安全策略](https://github.com/shebaoting/filament-modules/blob/HEAD/../../security/policy)以了解如何报告安全漏洞。
鸣谢
许可协议
MIT许可(MIT)。请参阅[许可文件](https://github.com/shebaoting/filament-modules/blob/HEAD/LICENSE.md)以获取更多信息。