gorriecoe/silverstripe-menu

Adds multiple menus that are defined via yml and managed via the cms.

Installs: 4 299

Dependents: 2

Suggesters: 0

Stars: 0

Watchers: 1

Forks: 2

Open Issues: 1

Type:silverstripe-vendormodule

1.2.2 2019-10-06 21:08 UTC

README

ko-fi

Adds multiple menus that are defined via yml and managed via the cms.

Installation

Composer is the recommended way of installing SilverStripe modules.

composer require gorriecoe/silverstripe-menu

Requirements

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

Maintainers

Creating custom menus

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

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.

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.

Usage in template

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

See silverstripe link for more template options.