Skip to content

ayuinc/Ruwasunchis

Repository files navigation

Easy Box Model (EBM)

Description

EBM or Easy Box Model is a set of automated and prebuilt Sass - Coffee - HTML5 - Grunt tools that significantly increase your productivity

The EBM allows you to decide which _*.scss, *.coffee, *.js files you want to compile to your final product plus:

  • Completely integrated with the latest Bootstrap 3
  • Get complete control of your background, text and border colors from a single _variables.scss file
  • Get complete control of each side of your html direct or children tags without touching any CSS
  • Run-once-and-for-all lightweight Sass set into a single styles.pkgd.min.css file without losing sight of your compiled CSS
  • Complete complex layouts with the use of the Flexbox predefined classes with prefixes and fallbacks
  • Take advantage of a modular Sass file structure for scalable websites and applications

Installing EBM

git clone https://github.com/netpoe/EasyBoxModel.git

Out-of-the-box tools

  • Twitter Bootstrap ^3.3.0
  • Bourbon Sass gem
  • Responsive text and headings
  • CSS Animate (converted to Sass partials)
  • VideoBG template with VideoJS
  • Flexbox ready to use classes (with fallbacks)
  • The actual EasyBoxModel Sass mixins, check out the full list of available shortcuts, loops and mixins
  • Everything is prefixed
  • Tested on modern Chrome, Firefox, IE9+, Opera
  • MORE AT THE BOTTOM

Usage

Development

grunt

Production

grunt build

Examples

Apply a margin top of 21px and a padding left of 35px to a div

<body>
	
	<div class="mt-21 pl-35"></div>

</body>

Apply a margin-bottom of 14rem and a padding left of 42rem to each list-item without touching your CSS

<ul class="mb-ch-21 pl-ch-42">
	<li></li>
	<li></li>
	<li></li>
	...
</ul>

Make all paragraphs inside a div have a gray-light color and a responsive .lead font-size

<div class="p-ch-primary lead-ch">
	<p></p>
	<p></p>
	<p></p>
	...
</div>

Build a mobile header

<header class="flex-space-between minh-70 border-bottom-gray-lighter normalize-text ph-14">
  <div class="left flex-middle">
    <nav>
      <a href="#">Link</a>
      <a href="#">Link 2</a>
    </nav>
  </div>
  <div class="center flex-middle text-center">
    <h3>Title</h3>
  </div>
  <div class="right flex-middle">
    <nav>
      <a href="#">Link 3</a>
      <a href="#">Link 4</a>
    </nav>
  </div>
</header>

For this example, the Sass $times variable is set to 7, so it works for values 7, 14, 21, 28, 35, 42, 49, 56, 63, 70.

Reference

Box Model Property Name Class Abbreviation Value
padding p- $times sass-variable-value
padding-top pt- $times sass-variable-value
padding-right pr- $times sass-variable-value
padding-bottom pb- $times sass-variable-value
padding-left pl- $times sass-variable-value
padding-* p*-sm $small sass-variable-value
padding-* p*-xs $xs sass-variable-value
margin m- $times sass-variable-value
margin-top mt- $times sass-variable-value
margin-right mr- $times sass-variable-value
margin-bottom mb- $times sass-variable-value
margin-left ml- $times sass-variable-value
margin-* m*-sm $small sass-variable-value
margin-* m*-xs $xs sass-variable-value

NOTE: The p*-sm, p*-xs, m*-sm, m*-xs classes are 5px and 3px respectively for $times 5 to 9, $times values from 1 to 4 are set to 1px on both sm and xs. IMPORTANT: You should not confuse this syntax with the media queries syntax.

EBM MEDIA QUERIES


Now you can create paddings and margins for different screen sizes as follow:

Box Model Property Name Class Abbreviation Value Screen size
padding p*- $times sass-variable-value - xs - sm - md - lg
margin m*- $times sass-variable-value - xs - sm - md - lg

EBM CHILD SIBLINGS


Alternatively, you can target one or more direct siblings of a parent element, e.g. a <ul class="mb-ch-21"></ul>

Example

<ul class="mb-ch-21-xs"> <!-- Will only apply on small devices -->
	<li></li>
	<li></li>
	<li></li>
</ul>
Box Model Property Name Class Abbreviation Value Screen size
padding p*-ch- $times sass-variable-value - xs - sm - md - lg
margin m*-ch- $times sass-variable-value - xs - sm - md - lg

EBM PERCENTAGE


The same as all of the above but applying a letter "p" for percentage as follows:

<div class="mlp-ch-21-sm">
	<!-- Will target children elements based on a 100% of the parent element relative sizing -->
</div>

EBM ADDITIONAL CLASSES AND HELPERS


Additionally, I found the following helpers useful on my projects

  • Background color helper classes including .bg-white that match the Bootstrap 3 color reference
  • Minimum heights minh-$times and minhp-$times
  • A _variables.scss sass partial for using EBM without bootstrap 3
  • .grid-list helper classes for creating grids based on floating list items (more on this later)

Extras

  • EBM $times variable default value is 7
  • EBM $times variable values are numbers from 1 to 9 only
  • EBM class abbr and property values go from (1 * $times) to (10 * $times), make sure to study your algebra
  • EBM works for IE8+ with a px unit fallback in each class
  • EBM works with rem CSS units for modern browsers
  • EBM em-base is set to 14px
  • EBM makes use of the px to rems and the strip-units Sass functions from bourbon.io

ROADMAP

The EBM can only keep growing, I'm working on a set of pre-built templates for complex dashboards and mobile applications.