org.civicrm.shoreditch (developmental)

The "Shoreditch" extension is a theme for CiviCRM based on a contemporary flat design and the Bootstrap v3 framework.

Please note that this extension is currrently in alpha stage and under active development. Significant elements may change.

Requirements

• Drupal 7
• CiviCRM, v5.0+ recommended
• "CiviCRM Theme" module enabled
• "Seven" theme set as CiviCRM Administration theme

For development, or for building the stylesheets it's necessary to have NodeJS v8.9.0

Supported CMSs

At the moment the theme is being developed to work only in Drupal 7 (with default theme set to "Seven"). WordPress and Joomla are not currently supported.

Installation (git/cli)

# Navigate to your extension directory, e.g.
cd sites/default/files/civicrm/ext

# Download and enable the extension
git clone https://github.com/civicrm/org.civicrm.shoreditch
cv en org.civicrm.shoreditch

# Enable the "CiviCRM Theme" module and set "Seven" as the Civi admin theme
drush en -y civicrmtheme
drush vset civicrmtheme_theme_admin seven
drush cc civicrm

If you are developing for the theme or if want the very latest (but untested) version of the theme on your site, run

cd org.civicrm.shoreditch
npm i

Once all the packages are installed gulp sass will be automatically invoked, which will build the stylesheets with the latest version of the source code.

Components

The theme includes two major components:

• "bootstrap.css" is a build of Bootstrap based on the standard Bootstrap style-guide. It can be used with other CiviCRM extensions which satisfy the Bootstrap style-guide.
• "custom-civicrm.css" is an optional replacement for "civicrm.css". It uses the same visual conventions and SCSS metadata, but it applies to existing core screens.

Using bootstrap.css

This extension provides the CSS for Bootstrap. Other extensions should output compliant HTML, e.g.

<div id="bootstrap-theme">
  ...
  <div class="panel panel-default">
    <div class="panel-heading">
      <h3 class="panel-title">Hello World</h3>
    </div>
    <div class="panel-body">
      This is the Hello World example.
    </div>
  </div>
  ...
</div>

Note the use of id="bootstrap-theme". To avoid conflicts with CMS UIs, the CSS rules are restricted to #bootstrap-theme.

Using custom-civicrm.css

This extension includes an optional file custom-civicrm.css which can replace the default civicrm.css. This uses the same CSS classes as traditional CiviCRM screens, but the look-and-feel matches the Bootstrap look-and-feel. It is implemented with the same SCSS variables and mixins. To use it, navigate to Administer -> System Settings -> Resource URLs And click on "Shoreditch" as the Custom CSS Url option.

Or from the command line:

cv api setting.create customCSSURL=$(cv url -x shoreditch/css/custom-civicrm.css --out=list)

Contributing

Want to report a bug, suggest enhancements, or contribute to the project? Please read here!