Modifying the UI Look and Feel

Logo

The logo should be 50px high, have a transparent background, and be in PNG format. Simply drop your logo into local/webroot/img/logo.png.

For versions prior to v1.0.0, you must replace the default image file that is located at app/webroot/img/comanage-logo.png.

 Custom logos per CO are not currently supported. (CO-1325)

Color scheme

The basic color scheme can be modified by downloading a theme from http://jqueryui.com/themeroller/ and unpacking the theme folder (e.g. smoothness, start, redmond) into app/webroot/js/jquery/ui/css/. Be sure to use the same jQuery UI version that Registry currently uses, which can be found via Version Dependencies.

Open app/views/layouts/default.ctp and change the appropriate reference to the location of the css file of the new theme.

Custom CO Themes & Custom Global Theme

As of v1.1.0, custom themes can be defined within each CO and used in various contexts. A custom theme defined for the COmanage CO can be applied globally, including unauthenticated contexts.

Themes can be added via Configuration >> Themes, and currently support the following options:

• CSS: Custom CSS to be used by the theme
• Header: Custom HTML to be emitted at the top of each rendered page
• Footer: Custom HTML to be emitted at the bottom of each rendered page
• Hide Footer Logo: If set, the "Powered by COmanage" logo will be suppressed
• Hide Title: If set, the title bar displaying the CO name and logo will be suppressed

After the theme has been defined, it can be attached to one of the following contexts (which are evaluated in order of priority as listed here):

1. Enrollment Flows: The theme will be rendered for petitions created from the specified Enrollment Flow
2. CO Settings: The theme will be rendered for all pages associated with the CO
3. COmanage CO Settings: In addition to being used for all pages associated with the COmanage CO, the theme will be used by default platform wide when no other theme has been selected

Building a Custom Theme

CSS from a custom theme is applied last in the cascade and can override any part of COmanage's styles.  When developing a custom theme, you can choose to include only CSS, or you can include CSS in combination with a custom header, footer, or both.

Output for the custom header will appear above all other elements in the following <header> tag:

<header id="customHeader">
  <div class="contentWidth">
    <!-- your custom markup will appear here -->
  </div>
</header>

Likewise, output for the footer will appear below all other elements in the following <footer> tag:

<footer id="customFooter">
  <div class="contentWidth">
    <!-- your custom markup will appear here -->
  </div>
</footer>

A step-by-step example

First, build the theme:

• As a CO administrator, visit Configuration --> Themes.
• Click "Add Theme" (or edit an existing theme).
• Provide a name for your theme in the Name field, e.g. "Test Theme".
• In the header, footer, and CSS fields provided, add the following content:
  
  

<!-- example markup for your header field -->
<h1>Custom Site Title</h1>
<div class="customElement">custom element</div>
<div class="customImage"><img src="https://upload.wikimedia.org/wikipedia/commons/1/16/NPS_map_symbols_spring.png"/></div>


<!-- example markup for your footer field -->
Custom Footer 
<!-- (Note that markup in the header and footer is optional and depends only on your needs.) -->


<!-- example styles for the CSS field -->
#customHeader,
#customHeader .contentWidth {
  position: relative;
}
#customHeader {
  padding: 1.5em;
  color: #fff;
  background: green;
  background: linear-gradient(black,green);
}
#customHeader h1 {
  font-weight: 700;
  font-size: 3em;
  font-family: "Palatino Linotype", "Book Antiqua", Palatino, serif;
  margin-top: 6px;
}
#customHeader .customElement {
  position: absolute;
  right: 10px;
  bottom: -1em;
}
#customHeader .customImage img {
  position: absolute;
  right: 0;
  top: -1em;
  width: 120px;
  height: auto;
}                                                       
#customFooter {
  background-color: green;
  bottom: 0;
  color: #fff;
  font-size: 1.4em;
  margin-top: 2em;
  padding: 1em 0 1.5em;
  position: fixed;
  text-align: center;
  width: 100%;
  background: green;
  background: linear-gradient(green,#222);
}

• Select the checkboxes to "Hide Title" and "Hide Footer Logo".
• Save your theme.

Next, apply the theme:

• Visit Configuration --> CO Settings.  (Alternately, visit Configuration --> Enrollment Flows and edit an enrollment flow to apply a theme just to it.)
• At the bottom of the settings form, select your newly created theme from the drop-down list.  Remember that any theme applied to the COmanage CO will render globally unless overridden by a more local theme applied to a CO or Enrollment Flow.
• Save the form.

Your CO should immediately change to look something like this:

Caveats

Be aware that using custom markup can break your page layout, so be sure to use valid HTML code in your header and footer.  Also, if your version of COmanage is responsive, you may wish to test your theme on phones, tablets, and different desktop sizes.

See Also: cm_co_themes