pxlrbt / filament-environment-indicator
Filament 内部当前环境的指示器
v2.0.2
2024-09-21 17:43 UTC
Requires
- php: ^8.0
- filament/filament: ^3.0-stable
Requires (Dev)
- laravel/pint: ^1.10
README
Filament 环境指示器
不再混淆不同的 Filament 环境的标签页。
通过 Composer 安装
composer require pxlrbt/filament-environment-indicator
使用方法
要使用此插件,请在您的面板配置中注册它
use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin; $panel ->plugins([ EnvironmentIndicatorPlugin::make(), ]);
配置
默认情况下,此插件会在管理面板顶部添加一个彩色边框,并在搜索栏旁边添加一个徽章。
您可以通过插件对象自定义任何行为。
自定义视图
使用 php artisan vendor:publish --tag="filament-environment-indicator-views"
将视图发布到 resources/views/vendor/filament-environment-indicator
文件夹。之后,您可以按需进行自定义!
可见性
默认情况下,该包会检查您是否已安装 Spatie 权限插件,并检查是否存在名为 super_admin
的角色。您可以进一步自定义是否显示指示器。
use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin; $panel->plugins([ EnvironmentIndicatorPlugin::make() ->visible(fn () => auth()->user()?->can('see_indicator')) ]);
颜色
如果您想使用自己的颜色或需要添加更多颜色,可以覆盖默认颜色。 ->color()
方法接受任何 Filament 的颜色对象或返回颜色对象的闭包。
use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin; use Filament\Support\Colors\Color; $panel->plugins([ EnvironmentIndicatorPlugin::make() ->color(fn () => match (app()->environment()) { 'production' => null, 'staging' => Color::Orange, default => Color::Blue, }) ]);
指示器
默认情况下,两个指示器都显示。您可以分别关闭它们。
use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin; use Filament\Support\Colors\Color; $panel->plugins([ EnvironmentIndicatorPlugin::make() ->showBadge(false) ->showBorder(true) ]);
贡献
如果您想为此包做出贡献,您可能希望在真实的 Filament 项目中对其进行测试
- 将此存储库分支到您的 GitHub 账户。
- 在本地创建 Filament 应用程序。
- 在 Filament 应用程序根目录中克隆您的分支。
- 在
/filament-environment-indicator
目录中,为您的修复创建一个分支,例如fix/error-message
。
在应用程序的 composer.json
中安装包
"require": { "pxlrbt/filament-environment-indicator": "dev-fix/error-message as main-dev", }, "repositories": [ { "type": "path", "url": "filament-environment-indicator" } ]
现在,运行 composer update
。