You are browsing the documentation for version 4.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Security Support ends in January 2023. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
Both the OroPlatform application and the OroCRM application come with a rich user interface. Each part of the application can be accessed by browsing the application using the provided navigation items.
OroPlatform leverages the famous KnpMenuBundle to provide highly customizable menus. You can add your own menu items to access your project specific interfaces or even replace existing items.
Mastering the application menu is a two-step process:
The OroNavigationBundle automatically processes a YAML configuration file which is named
navigation.yml when it is placed in the
Resources/config/oro directory of a registered bundle.
The menu configuration needs to be placed under the
Create Menu Items
You can create new navigation under the
items key. Each item must be identified by a unique
name which acts as a key in the menu configuration:
1 2 3 4 5 6 7 8 9 10 11 12
# src/Acme/DemoBundle/Resources/config/oro/navigation.yml menu_config: items: blog: label: acme_demo.menu.blog uri: '#' blog_categories: label: acme_demo.menu.blog_categories route: acme_demo.blog_categories blog_index: label: acme_demo.menu.blog_overview route: acme_demo.blog_index
The example above defines three menu items:
blogitem consists of a label and the URI
#. This means that the item will not react on mouse clicks, but can be used as a placeholder for nested menus.
- Both the
blog_indexitems reference an existing route. Thus, when the user later clicks one of these items, they will get to a page that is rendered by the controller that is responsible for the configured route.
As you can see, the menu item labels will be translated by default. Hence you can use arbitrary
labels here, as long as they can be translated by configured
translator service. You can change
the translation domain using the
translateDomain option (by default, the translator’s default
domain will be used).
Organize the Navigation Trees
The next step is to compose a tree of the menu items that you created before. These trees are
build under the
1 2 3 4 5 6 7 8 9 10 11
# src/Acme/DemoBundle/Resources/config/oro/navigation.yml menu_config: tree: application_menu: children: system_tab: children: blog: children: blog_categories: ~ blog_index: ~
First, you need to decide to which tree the items should be added. The Oro applications come with three pre-defined menus to which you can add new items:
The horizontal main menu on top of the user interface.
The menu that pops up when the user clicks on their username in the top right corner of the screen.
- The shortcut bar above the main application menu.
In the example above, you can also see that you can add menu items to already existing subtrees. With the given configuration, the blog menu will appear under the existing System tab of the application menu.
If you wanted to create a dedicated blog tab instead, you would just have to configure your items
as child items of the
application_menu entry like this:
1 2 3 4 5 6 7 8 9
# src/Acme/DemoBundle/Resources/config/oro/navigation.yml menu_config: tree: application_menu: children: blog: children: blog_categories: ~ blog_index: ~
The goal of breadcrumb provider is to provide possibility to show a breadcrumbs based on specific menu defined in navigation.yml. You can get the breadcrumbs through any existing menu alias. Menu can be created and used for breadcrumbs structure only.
To use breadcrumb provider, create layout update with the predefined breadcrumbs block type and the menu_name option:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
# CustomerBundle/Resources/views/layouts/blank/imports/oro_customer_page/oro_customer_page.yml layout: imports: - id: oro_customer_menu root: page_sidebar actions: - '@add': id: breadcrumbs parentId: page_main_header blockType: breadcrumbs #block type options: menu_name: "oro_customer_breadcrumbs_menu" #menu alias
Breadcrumbs Block Type
You can avoid usage of breadcrumb provider. For that, you should create layout update with the predefined breadcrumbs block type and the breadcrumbs option:
1 2 3 4 5 6 7 8 9 10 11 12
# WebCatalogBundle/Resources/views/layouts/blank/oro_product_frontend_product_index/product_index.yml layout: actions: - '@setBlockTheme': themes: 'WebCatalogBundle:layouts:blank/oro_product_frontend_product_index/product_index.html.twig' - '@addTree': items: category_breadcrumbs: blockType: breadcrumbs options: breadcrumbs: '=data["category_breadcrumbs"].getItems()'
After the breadcrumbs block type rendering, you should see menu labels separated by slashes. All breadcrumb items can be clickable, except the last one which represents the current page.
OroNavigationBundle helps manage page titles for all routes and supports titles translation. Rout titles can be defined in the navigation.yml file:
1 2 3 4
titles: route_name_1: "%parameter% - Title" route_name_2: "Edit %parameter% record" route_name_3: "Static title"
Title can be defined with annotation together with route annotation:
@TitleTemplate("Route title with %parameter%")