silverstripe-australia/grouped-cms-menu

Allows you to group CMS menu items.

SilverStripe Grouped CMS Menu

This module allows you to group CMS menu items into nested lists which expand when hovered over. This is useful when there are so many CMS menu items that screen space becomes an issue., _(*1)

Previous versions are available through the appropriate branch., _(*2)

Basic Usage

In order to group CMS menu items together, define your menu groups in a config.yml file., _(*3)

In the example below, CMSMain (Pages) and AssetAdmin (Files & Images) are grouped together under a "Content" heading., _(*4)

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    Content:
      children:
        - SilverStripe-CMS-Controllers-CMSPagesController
        - SilverStripe-AssetAdmin-Controller-AssetAdmin

Sort order

The items in each grouped menu will follow the order you set in your YML. The groups themselves will be inserted in the menu with a priority of 0, with other menu items appearing above or below depending on their existing priority. You can change the priority of a menu group like this:, _(*5)

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    Other:
      priority: -500
      children:
        - SilverStripe-Reports-ReportAdmin
        - SilverStripe-Admin-SecurityAdmin

Or you can "group" items by themselves to make any menu item follow the order you set in your configuration:, _(*6)

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    SilverStripe\CMS\Controllers\CMSPagesController:
      children:
        - SilverStripe-CMS-Controllers-CMSPagesController
    Other:
      children:
        - SilverStripe-Reports-ReportAdmin
        - SilverStripe-Admin-SecurityAdmin

When you have larger menus, and/or multiple modules combining to the same menu, this may require something more consistent. In which case, you may sort your grouped menus alphabetically., _(*7)

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    SilverStripe\CMS\Controllers\CMSPagesController:
      children:
        - SilverStripe-CMS-Controllers-CMSPagesController
    Other:
      children:
        - SilverStripe-Reports-ReportAdmin
        - SilverStripe-Admin-SecurityAdmin
  menu_groups_alphabetical_sorting: true

Group icons

You can add a CSS class to groups for the purpose of adding an icon. The class name will be prefixed with 'font-icon-'. In the example below the same icon used for the Pages menu item will be used for the Content group:, _(*8)

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    Content:
      icon: 'sitemap'
      children:
        - SilverStripe-CMS-Controllers-CMSPagesController
        - SilverStripe-AssetAdmin-Controller-AssetAdmin;

Translating group labels

A group label may be translated by providing a translation key as below (using the 'Other' group from above as an example), _(*9)

langcode:
  GroupedCmsMenuLabel:
    Other: 'translated text'

If the group label has spaces, these will be converted to underscores for the key, _(*10)

langcode:
  GroupedCmsMenuLabel:
    Other_Label: 'translated text'

Requirements

• SilverStripe 4+ and 5+ (See other branches for compatibility with older versions)

Project Links

• GitHub Project Page
• Issue Tracker

Credits

• A massive thanks to Russ Michell (phptek) for upgrading this module to be SS4 compatible!