[Docs] Improve menu customization

Sylius · Dec 23, 2024 · 7662935 · 7662935
1 parent 0292696
commit 7662935
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 1 deletion.
diff --git a/app/Menu/AdminMenuBuilder.php b/app/Menu/AdminMenuBuilder.php
@@ -47,7 +47,7 @@ private function addLibrarySubMenu(ItemInterface $menu): void
         $library = $menu
             ->addChild('library')
             ->setLabel('app.ui.library')
-            ->setLabelAttribute('icon', 'tabler:users')
+            ->setLabelAttribute('icon', 'tabler:books')
         ;
 
         $library->addChild('books', ['route' => 'app_admin_book_index'])

diff --git a/docs/.gitbook/assets/sidebar_menu.png b/docs/.gitbook/assets/sidebar_menu.png
diff --git a/docs/.gitbook/assets/submenu_items.png b/docs/.gitbook/assets/submenu_items.png
diff --git a/docs/cookbook/admin_panel/menu.md b/docs/cookbook/admin_panel/menu.md
@@ -2,6 +2,14 @@
 
 ## How to customize the sidebar menu
 
+### Decorate the sidebar menu
+
+<div data-full-width="false">
+
+<figure><img src="../../.gitbook/assets/sidebar_menu.png" alt="Sidebar menu"></figure>
+
+</div>
+
 To customize the admin menu, you need to decorate the `sylius_admin_ui.knp.menu_builder` service.
 
 ```php
@@ -38,3 +46,46 @@ final readonly class MenuBuilder implements MenuBuilderInterface
     }
 }
 ```
+
+### Add submenu items
+
+<div data-full-width="false">
+
+<figure><img src="../../.gitbook/assets/submenu_items.png" alt="Submenu items"></figure>
+
+</div>
+
+Now you can add submenu items:
+
+```php
+#[AsDecorator(decorates: 'sylius_admin_ui.knp.menu_builder')]
+final readonly class MenuBuilder implements MenuBuilderInterface
+{
+    // ...
+
+    public function createMenu(array $options): ItemInterface
+    {
+        $menu = $this->factory->createItem('root');
+
+        // ...
+
+        $this->addLibrarySubMenu($menu);
+
+        return $menu;
+    }
+
+    private function addLibrarySubMenu(ItemInterface $menu): void
+    {
+        $library = $menu
+            ->addChild('library')
+            ->setLabel('app.ui.library')
+            ->setLabelAttribute('icon', 'tabler:books')
+        ;
+
+        $library->addChild('books', ['route' => 'app_admin_book_index'])
+            ->setLabel('app.ui.books')
+            ->setLabelAttribute('icon', 'book')
+        ;
+    }
+}
+```