Filament Menu Builder 使用教程

1. 项目介绍

Filament Menu Builder 是一个开源的 Filament 扩展包，它允许开发者在 Filament 应用中创建和管理菜单。这个扩展包提供了多种菜单面板类型，包括自定义链接、自定义文本、静态菜单和模型菜单等，以方便地在应用的各个位置（如头部、尾部）展示菜单。

2. 项目快速启动

安装

首先，确保你已经安装了 Filament。然后，你可以通过 Composer 安装 Filament Menu Builder：

composer require datlechin/filament-menu-builder

发布迁移和配置文件

接下来，发布迁移文件和配置文件：

php artisan vendor:publish --tag=filament-menu-builder-migrations
php artisan migrate

如果需要自定义配置，可以发布配置文件：

php artisan vendor:publish --tag=filament-menu-builder-config

发布视图（可选）

如果你想要自定义视图，可以发布它们：

php artisan vendor:publish --tag=filament-menu-builder-views

添加插件到 Filament 面板

在 AdminPanelProvider 中添加 Filament Menu Builder 插件：

use Datlechin\FilamentMenuBuilder\FilamentMenuBuilderPlugin;

// ...

$panel->plugin(FilamentMenuBuilderPlugin::make());

添加菜单位置

在 AdminPanelProvider 中定义菜单位置：

$panel->plugin(
    FilamentMenuBuilderPlugin::make()
        ->addLocation('header', 'Header')
        ->addLocation('footer', 'Footer')
);

设置菜单面板

你可以添加各种类型的菜单面板：

use Datlechin\FilamentMenuBuilder\MenuPanel\StaticMenuPanel;

// ...

$panel->plugin(
    FilamentMenuBuilderPlugin::make()
        ->addMenuPanels([
            StaticMenuPanel::make()
                ->add('Home', url('/'))
                ->add('Blog', url('/blog')),
        ])
);

3. 应用案例和最佳实践

自定义链接菜单面板

默认情况下，Filament Menu Builder 提供了一个自定义链接菜单面板，允许添加自定义链接到菜单中。你可以通过以下方式禁用此面板：

$panel->plugin(
    FilamentMenuBuilderPlugin::make()
        ->showCustomLinkPanel(false)
);

自定义文本菜单面板

此面板允许添加不包含 URL 或目标的文本项到菜单中，这对于添加菜单标题很有用。要启用此面板，可以使用：

$panel->plugin(
    FilamentMenuBuilderPlugin::make()
        ->showCustomTextPanel()
);

模型菜单面板

模型菜单面板允许从模型中添加菜单项。首先，你的模型需要实现 MenuPanelable 接口和 HasMenuPanel 特性。然后，实现相关方法：

class Category extends Model implements MenuPanelable
{
    use HasMenuPanel;

    public function getMenuPanelTitleColumn(): string
    {
        return 'name';
    }

    public function getMenuPanelUrlUsing(): callable
    {
        return fn ($model) => route('categories.show', $model->slug);
    }
}

接着，将模型菜单面板添加到插件：

$panel->plugin(
    FilamentMenuBuilderPlugin::make()
        ->addMenuPanels([
            ModelMenuPanel::make()
                ->model(App\Models\Category::class),
        ])
);

4. 典型生态项目

Filament Menu Builder 可以与其他 Filament 扩展包配合使用，构建功能丰富的后台管理系统。例如，与 Filament Table Builder 结合，可以创建具有菜单功能的表格，或与 Filament Forms 配合，为菜单项添加自定义表单字段。通过这些扩展包的组合使用，可以打造出强大且灵活的后台管理系统。