README.md

Silverstripe CMS Branding

Just a nice little UI change for the cms sidebar.

The theme supports an UploadField in the Settings > Settings Tab > CMS Tab for a logo to be displayed in the left-hand menu of the CMS.

Screenshot

Thanks

Thanks to https://github.com/symbiote/silverstripe-grouped-cms-menu for some of their code for grouped menu items.

Installation

composer require ryanpotter/silverstripe-cms-theme

Configuration

You can either choose to upload a CMS logo through the Site Settings section of the CMS, or you can define it through a YML configuration like the below:

SilverStripe\SiteConfig\SiteConfig:
  cms_logo: 'path/to/your/image.png'
  cms_logo_width: 100 # Optional width constraint

You can set the theme colour of the left menu by defining it through a YML configuration like the below:

SilverStripe\Admin\LeftAndMain:
  cms_background: '#1d48a0'
  cms_border_color: '#173778'
  cms_color: '#fff'
  cms_hover_background: 'inherit'
  cms_hover_color: currentColor
  cms_active_background: '#173778'
  cms_active_color: currentColor
  cms_drawer_background: '#1a3e88'
  cms_drawer_color: currentColor
  cms_icon_color: currentColor

Grouping CMS Menus

You can add menu items to a list by using adding the menu code to the menu_groups config e.g:

SilverStripe\Admin\LeftAndMain:
  menu_groups:
    Misc:
      icon_class: 'fa fa-folder' # (optional) Defaults to 'fa fa-folder'
      priority: 0 # (optional) Defaults to menu item order
      items:
        - SilverStripe-CampaignAdmin-CampaignAdmin
        - Help
        - SilverStripe-Reports-ReportAdmin

Overriding/Adding Icons

The icons in this cms theme use Font Awesome, to override these icons simply add the class that represents the icon you wish to display in your ModelAdmin extension. e.g:

private static $menu_icon_class = 'fas fa-pencil-alt';

Alternatively you can set this using a YML config. e.g

SilverStripe\CMS\Controllers\CMSPagesController:
  menu_icon_class: 'fas fa-sitemap'