The MenuRegistry is part of the DocHeaderComponent and holds all menus that should be displayed in the module's header area.

Menus are typically used to provide navigation between different views or modes within a module (e.g., switching between list/grid view, or different content types).

Example:

public function __construct(
    protected readonly ComponentFactory $componentFactory,
) }

public function myAction(): ResponseInterface
{
    // Get the menu registry from the module template
    $menuRegistry = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry();

    // Create and configure a menu
    $menu = $this->componentFactory->createMenu();
    $menu->setIdentifier('viewSelector')->setLabel('View');

    // Add menu items
    $listItem = $this->componentFactory->createMenuItem()
        ->setTitle('List')
        ->setHref('/module?view=list')
        ->setActive($currentView === 'list');
    $menu->addMenuItem($listItem);

    // Register the menu
    $menuRegistry->addMenu($menu);
}