last edited bylmajano on 05-Jan-2010

History 

<< Back to Dashboard | << Interceptors Viewer

ColdBox SideBar

Introduction

Well, because an image says more than 1000 words...

Sure, the ColdBox SideBar still works on exception...

Configuration

Enabling the ColdBoxSideBar is easy!

Coldbox.xml.cfm

Step 1: Enable ColdBoxSideBar Setting

In order for the sidebar to render, you need to enable it via a custom setting in <YourSettings> element. This setting is called ColdBoxSideBar and it must be a boolean variable.

<YourSettings>
   <Setting name="ColdBoxSideBar" value="true" />
</YourSettings>

Step 2: Add ColdBoxSideBar Interceptor

<Interceptor class="coldbox.system.interceptors.coldboxSideBar">
   <Property name="yOffset">50</Property>
   <Property name="isScroll">false</Property>
   <Property name="slideSpeed">15</Property>
   <Property name="waitTimeBeforeOpen">0</Property>
   <Property name="waitTimeBeforeClose">250</Property>
   <Property name="links">
      [
      {"desc":"ColdBox API","href":"http:\/\/www.coldbox.org\/api\/"}
      ,{"desc":"ColdBox SideBar Help","href":"http:\/\/ortus.svnrepository.com\/coldbox\/trac.cgi\/wiki\/cbSideBar"}
      ,{"desc":"ColdBox Credits","href":"http:\/\/ortus.svnrepository.com\/coldbox\/trac.cgi\/wiki\/cbCredits"}
      ]
   </Property>
   <-- <Used for Skinning -->
   <Property name="width"></Property>
   <Property name="visibleWidth"></Property>
   <Property name="imagePath"></Property>
   <Property name="imageVAlign"></Property>
   <Property name="cssPath"></Property>
</Interceptor>
 

Interceptor Properties

Best Practise: Use The Environment Interceptor

Normally you don't want to enable the ColdBoxSideBar in live environments, it's a development gadget. So the best way to go is by using the [[Interceptors:EnvironmentControl | environment interceptor]!

Follow these steps to setup the ColdBoxSideBar:

Step 1: Setup Environment Interceptor

See environment interceptor

Step 2: Disable ColdBoxSideBar on Live Server

<Setting name="ColdBoxSideBar" value="false" />

Step 3: Enable ColdBoxSideBar on Development Server

Add ColdBoxSideBar custom setting:

<Setting name="ColdBoxSideBar" value="true" />

Your environment.xml.cfm should look something like this:

<?xml version="1.0" encoding="ISO-8859-1"?>
<environmentcontrol>
   <environment name="development" urls="localhost">
      <Setting name="EnableDumpVar" value="true" />	
      <Setting name="ColdBoxSideBar" value="true" />
   </environment>
</environmentcontrol>

Skinning the ColdBox SideBar

Of course, you can skin the ColdBoxSideBar! Take a look at the interceptor properties! Create your own image and adjust a copy of the stylesheet in /coldbox/includes/coldboxsidebar/_ColdBoxSideBar.css. Make sure you use the right paths though!

Please, send us a screenshot of your custom skin!

Usage

You can only enable the ColdBox SideBar through url (sbIsEnabled=1) if the enable sidebar setting is set to true

Download in other Formats:
Markup | PDF | HTML | Word

Comments (2)

Add Comment

orcpac8 said

at 03:15:13 PM 28-Jan-2010

Any chance of getting a quick note as to how to configure in M4, Coldbox.cfc configuration file? Doesn't need explanation, but syntax would be helpful. Getting lost in the nested array of links with multiple properties.

Luis Majano said

at 07:49:36 PM 28-Jan-2010

Yes, we will update all the docs soon