README

为您的应用页面添加面包屑。

安装方法

步骤 1：下载组件

打开命令行，进入项目目录并执行以下命令以下载此组件的最新稳定版本

composer require osw3/symfony-breadcrumb

步骤 2：启用组件

然后，通过将其添加到项目 config/bundles.php 文件中注册的组件列表中来启用组件

// config/bundles.php

return [
    // ...
    OSW3\Breadcrumb\BreadcrumbBundle::class => ['all' => true],
];

步骤 3：向 Twig 暴露组件

将面包屑添加到 Twig 组件设置 config/packages/twig_component.yaml

twig_component:
    defaults:
        #...
        OSW3\Breadcrumb\Components\: '@Breadcrumb/'

如何使用

步骤 1：编辑控制器

编辑需要面包屑的每个控制器，并添加 "Breadcrumb" 属性。

class ProductController extends AbstractController
{
    #[Route('/products', name: 'app_product')]
    #[Breadcrumb([['label' => "Products", 'route' => "app_product"]])]
    public function index(): Response
    {
        // ...
    }
}

或者添加多个项

class BookController extends AbstractController
{
    #[Route('/books', name: 'app_books')]
    #[Breadcrumb([
        ['label' => "Products", 'route' => "app_product"]
        ['label' => "Books", 'route' => "app_books"]
    ])]
    public function index(): Response
    {
        // ...
    }
}

步骤 2：Twig 组件

在您的 twig 文件中使用

<twig:Breadcrumb />

或者使用自定义 ID 和/或自定义类

<twig:Breadcrumb id="my-custom-id" class="my-custom-class" />

如何配置

面包屑配置位于 config/package/breadcrumb.yaml。

配置示例

breadcrumb:
    home:
        label: Home
        route: app_homepage
        icon: 'fa fa-home'
        domain: null
    template: default
    separator: null
    items:
        class: null
        absolute: false
    hide_empty: true

osw3 / symfony-breadcrumb

维护者

详细信息