gorriecoe/silverstripe-menu

Creates multiple menus.

Silverstripe menus

Adds multiple menus that are defined via yml and managed via the cms., _(*1)

Installation

Composer is the recommended way of installing SilverStripe modules., _(*2)

composer require gorriecoe/silverstripe-menu

Requirements

• silverstripe/framework ^4.0
• symbiote/silverstripe-gridfieldextensions ^3.1
• gorriecoe/silverstripe link ^1.1

Maintainers

• Gorrie Coe

Creating custom menus

As it is common to reference MenuSets by slug in templates, you can configure sets to be created automatically during the /dev/build task. These sets cannot be deleted through the CMS., _(*3)

gorriecoe\Menu\Models\MenuSet:
  sets:
    main: Main menu
    secondary: Another menu

Nested and flat menus

By default menus will be flat, which means links can not have child links associated with them. If you need a nested menu structure, you can do so by adding allow_children: true to the yml file as shown below., _(*4)

gorriecoe\Menu\Models\MenuSet:
  sets:
    footer:
      title: Footer menu
      allow_children: true

Adding links to menus

Once you have created your menus you can add links in the admin area. The fields are inherited from silverstripe link., _(*5)

Automatically add links from sitetree to specific menus

If you need to automatically add links to a menu after the creation of a page, you can do so by adding the following extension to page and defining owns_menu., _(*6)

Page:
  extensions:
    - gorriecoe\Menu\Extensions\SiteTreeAutoCreateExtension
  owns_menu:
    - main
    - footer

Usage in template

<ul>
    <% loop MenuSet('footer') %>
        <li>
            {$Me}
        </li>
    <% end_loop %>
</ul>

See silverstripe link for more template options., _(*7)