Defining Navigation

The menu items for managing the content in the admin panel.

Extra Navigation

In the backend area, entries will be listed under the Content menu item with globals listed under the Settings menu item (by default). You may control this behavior using the navigation property in the blueprint file. The following code will set an icon and specify the order of appearance.

navigation:
    icon: icon-pencil
    order: 200

The following properties are supported by the navigation and primaryNavigation definition.

Property	Description
label	specifies the menu label localization string key, required.
order	a numerical weight when determining the display order.
parent	links the navigation item to a parent item using a blueprint handle.
icon	an icon name from the October CMS icon collection, optional.
iconSvg	an SVG icon to be used in place of the standard icon, the SVG icon should be a rectangle and can support colors, optional.

To place an item in the Settings area, set the parent to settings. The category definition can be a string or a settings constant reference, eg. CATEGORY_COLLECTIONS.

navigation:
    parent: settings
    category: Collections

To place an item in the Content area, set the parent to content.

navigation:
    parent: content

To place the item as a primary navigation item. A primaryNavigation definition is needed.

primaryNavigation:
    label: Blog
    icon: icon-copy
    order: 500

navigation:
    label: Main Menu Item

To place the item as a secondary navigation item. The parent property should specify the UUID or handle of a primary navigation item.

navigation:
    parent: <handle|uuid>

To disable the secondary navigation, define the primaryNavigation for a single blueprint without it being a parent for any other blueprints.

primaryNavigation:
    label: Page
    icon: icon-magic
    order: 500

You may also completely disable the navigation by setting the navigation property to false.

navigation: false

Use the extraNavigation property to register custom navigation items to include with the blueprint. The value is an array matching the sideMenu definition found in the backend navigation specification. The following example includes two a section and divider using custom display types, the order property is used to align the items in the correct order.

navigation:
    label: Authors
    parent: Blog\Post
    icon: icon-user
    order: 230

extraNavigation:
    _authors_section:
        itemType: section
        label: Authors
        order: 210

    _authors_ruler:
        itemType: ruler
        order: 220

You may also register links to controllers introduced by plugins by specifying the url property. This property should be set to the controller URL, the following links to the acme/blog/posts controller.

navigation:
    label: Authors
    # ...

extraNavigation:
    testimonials:
        label: Testimonials
        order: 210
        icon: icon-group
        url: acme/blog/posts

To set the navigation context inside the controller, use the setTailorContext method on the BackendMenu facade. You may also specify the blueprint uuid with the setTailorContextUuid method. The method takes the handle or uuid of the blueprint (first argument), and the key used by the extra navigation item (second argument).

BackendMenu::setTailorContext('Blog\Post', 'testimonials');

BackendMenu::setTailorContextUuid('edcd102e-0525-4e4d-b07e-633ae6c18db6', 'testimonials');

# See Also

Backend Navigation

← Content Fields Models →