Skip to content

Latest commit

 

History

History
161 lines (112 loc) · 4.13 KB

README.md

File metadata and controls

161 lines (112 loc) · 4.13 KB
Raw

Silverstripe Menu Manager

The menu management module is for creating custom menu structures when the site tree hierarchy just won't do.

License

Menu Manager is licensed under an MIT license

Installation

composer require heyday/silverstripe-menumanager

After completing this step, navigate in Terminal or similar to the SilverStripe root directory and run composer install or composer update depending on whether or not you have composer already in use.

Usage

There are 2 main steps to creating a menu using menu management.

  1. Create a new MenuSet
  2. Add MenuItems to that MenuSet

Creating a MenuSet

This is pretty straight forward. You just give the MenuSet a Name (which is what you reference in the templates when controlling the menu).

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.

Heyday\MenuManager\MenuSet:
    default_sets:
        - Main
        - Footer

Creating MenuItems

Once you have saved your MenuSet you can add MenuItems.

MenuItems have 4 important fields:

  1. Page
  2. MenuTitle
  3. Link
  4. IsNewWindow

Page

A page to associate your MenuItem with.

MenuTitle

This field can be left blank if you link the menu item with a page. If not fill with the title you want to display in the template.

Link

This field can be left blank unless you want to link to an external website. When left blank using $Link in templates will automatically pull the link from the MenuItems associated Page. If you enter a link in this field and then pick a Page as well the link will be overwritten by the Page you chose.

IsNewWindow

Can be used as a check to see if 'target="_blank"' should be added to links.

Disable creating Menu Sets in the CMS

Sometimes the defined default_sets are all the menu's a project needs. You can disable the ability to create new Menu Sets in the CMS:

Heyday\MenuManager\MenuAdmin:
    enable_cms_create: false

Note: Non-default Menu Sets can still be deleted, to help tidy unwanted CMS content.

Usage in template

<% loop $MenuSet('YourMenuName').MenuItems %>
<a href="{$Link}" class="{$LinkingMode}">{$MenuTitle}</a>
<% end_loop %>

To loop through all MenuSets and their items:

<% loop $MenuSets %>
	<% loop $MenuItems %>
		<a href="$Link" class="$LinkingMode">$MenuTitle</a>
	<% end_loop %>
<% end_loop %>

Optionally you can also limit the number of MenuSets and MenuItems that are looped through.

The example below will fetch the top 4 MenuSets (as seen in Menu Management), and the top 5 MenuItems for each:

<% loop $MenuSets.Limit(4) %>
	<% loop $MenuItems.Limit(5) %>
		<a href="$Link" class="$LinkingMode">$MenuTitle</a>
	<% end_loop %>
<% end_loop %>

Enabling partial caching

Partial caching can be enabled with your menu to speed up rendering of your templates.

<% with $MenuSet('YourMenuName') %> <% cached 'YourMenuNameCacheKey',
$LastEdited, $MenuItems.max('LastEdited'), $MenuItems.count %> <% if $MenuItems
%>
<nav>
    <% loop $MenuItems %>
    <a href="{$Link}" class="{$LinkingMode}"> $MenuTitle.XML </a>
    <% end_loop %>
</nav>
<% end_if %> <% end_cached %> <% end_with %>

Allow sorting of MenuSets

By default menu sets cannot be sorted, however, you can set your configuration to allow it.

Heyday\MenuManager\MenuSet:
    allow_sorting: true

Subsite Support

If you're using SilverStripe Subsites, you can make MenuManager subsite aware via applying an extension to the MenuSet.

app/_config/menus.yml

Heyday\MenuManager\MenuSet:
  create_menu_sets_per_subsite: true
  extensions:
    - Heyday\MenuManager\Extensions\MenuSubsiteExtension
Heyday\MenuManager\MenuItem:
  extensions:
    - Heyday\MenuManager\Extensions\MenuSubsiteExtension

Code guidelines

This project follows the standards defined in: