README

一个主要用于在Filament Admin导航面板底部显示框架版本，以及在仪表板或自定义页面中可选的小部件的几乎无用的包。

安装

通过composer安装此包

composer require awcodes/filament-versions

为了与Filament的主题方法保持一致，您需要使用自定义主题来使用此插件。

注意如果您尚未设置自定义主题并且正在使用面板，请首先按照Filament 文档中的说明操作。

将插件视图添加到您的tailwind.config.js文件中。

content: [
    '<path-to-vendor>/awcodes/filament-versions/resources/**/*.blade.php',
]

用法

在您的面板提供商中注册插件和/或小部件

use Awcodes\FilamentVersions\VersionsPlugin;
use Awcodes\FilamentVersions\VersionsWidget;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make(),
        ])
        ->widgets([
            VersionsWidget::class,
        ]);
}

注意如果您正在使用面板的topNavigation选项，则侧边栏小部件将显示在页面内容底部。

禁用导航视图

如果您想禁用导航视图并仅使用仪表板小部件，您可以通过传递false或一个闭包到hasNavigationView方法来实现。

use Awcodes\FilamentVersions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->hasNavigationView(false),
        ]);
}

自定义项

您可以通过创建一个新的实现VersionProvider接口的类来向小部件添加自定义项。

use Awcodes\FilamentVersions\Providers\Contracts\VersionProvider;

class MyCustomVersionProvider implements VersionProvider
{
    public function getName(): string
    {
        return 'My Custom Version';
    }

    public function getVersion(): string
    {
        return '1.0.0';
    }
}

然后将项添加到插件中

use Awcodes\FilamentVersions\VersionsPlugin;
use App\Filament\VersionProviders\MyCustomVersionProvider;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->items([
                    new MyCustomVersionProvider(),
                ]),
        ]);
}

禁用默认项

您可以通过传递false或一个闭包到hasDefaultItems方法来禁用默认项。

use Awcodes\FilamentVersions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->hasDefaults(false)
        ]);
}

小部件选项

您可以通过在插件上设置它们来更改小部件的列宽和顺序。

use Awcodes\FilamentVersions\VersionsPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            VersionsPlugin::make()
                ->widgetColumnSpan('full')
                ->widgetSort(2),
        ]);
}

变更日志

有关最近更改的更多信息，请参阅变更日志。

贡献

有关详细信息，请参阅贡献指南。

安全漏洞

有关如何报告安全漏洞的详细信息，请参阅我们的安全策略。

鸣谢

许可证

MIT 许可证 (MIT)。有关更多信息，请参阅许可证文件。

awcodes / filament-versions

维护者

详细信息