Compact Navigator Module

Compact navigator can be used to replace the standard Silverstripenavigator method, with a streamlined, themable menu, that can be accessed by clicking the sliverstripe menu that appears in the top right of the screen.

Summary

Download the latest version.
Get the latest build from version control.
Or browse the source code.

Further Info

Compact navigator can be used to replace the standard Silverstripenavigator method, with a streamlined, themable menu, that can be accessed by clicking the sliverstripe menu that appears in the top right of the screen.

Install Instructions

  1. Upload the Silverstripe Dashboard module to the "dashboard" folder in your SilverStripe root folder
  2. Run dev/build?flush=1
  3. Login to your administration panel - hopefully it works!

Template tutorial

Compact Navigator allows for a wide range of customisation. Everything from altering styles, custom javascript to better integrate with your theme or even completely customised templates.

Customisation is really simple, just follow the steps below:

Customising CSS

  1. Copy the default Navigator CSS file from /compactnavigator/css/CompactNavigator.css to your own css folder.
  2. Open the CSS file in your prefered editor.
  3. Either add your own enhancements, or clear the file and start from scratch.
  4. Finally, in your /mysite/_config.php file, add the line:
    CompactNavigator::$CssTheme = /path/to/your/CompactNavigator.css

Compact Navigator will now load your new css file, in place of the default one.

Customising JavaScript

  1. Copy the default Navigator JavaScript file from /compactnavigator/scripts/CompactNavigator.js to your own Javascript folder.
  2. Open the JavaScript file in your prefered editor.
  3. Either add your own enhancements, or clear the file and start from scratch.
  4. Finally, in your /mysite/_config.php file, add the line:
    CompactNavigator::$JsTheme = /path/to/your/CompactNavigator.js

Compact Navigator will now load your new JavaScript file, in place of the default one.

Customising the Template

  1. Copy the default Navigator Template from /compactnavigator/templates/Includes/CompactNavigator.ss to your own Templates/Includes folder.
  2. Open theTemplate file in your prefered editor.
  3. Either add your own enhancements, or clear the file and start from scratch.
  4. Finally, in your /mysite/_config.php file, add the line:
    CompactNavigator::$Template = 'TemplateFileName'

Please Note: Ensure you do not add the .ss extension to the $Template variable. Also, for some reason, Silverstripe won't load templates with the name CompactNavigator.ss, so you will have to rename your template file.

In this section