Git Product home page Git Product logo

org.civicrm.shoreditch's Introduction

org.civicrm.shoreditch (developmental)

The "Shoreditch" extension is a theme for CiviCRM based on a contemporary flat design and Bootstrap(S)CSS. It 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.

This extension is under active development. Significant elements may change.

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!

org.civicrm.shoreditch's People

Contributors

brunoqueiros avatar mukeshcompucorp avatar reneolivo avatar deb1990 avatar danilo-compucorp avatar aka84 avatar kkalamarski avatar davialexandre avatar igorpavlov avatar totten avatar colemanw avatar meladawy avatar bmnepali avatar victorlenerd avatar guanhuan avatar tunbola avatar omarabuhussein avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.