Skip to content

Latest commit

 

History

History
152 lines (111 loc) · 4.39 KB

README.md

File metadata and controls

152 lines (111 loc) · 4.39 KB
Raw

Emmet-like utility classes for rapid and easy front-end development.

Circle CI NPM Version License

Example

Emma.css class Emmet abbreviation Declaration (Expanded abbreviation)
.d-b d-b display: block;
.d-fx d-fx display: flex;
.m-a m-a marign: auto;
.m0 m0 margin: 0;
― m-5 margin: -5px;
.w1 w1 width: 1px;
.h100p h100p height: 100%;
.mah50vh mah50vh max-height: 50vh;
.ff-t ff-t font-family: "Times New Roman", Times, Baskerville, Georgia, serif;
.fz16 fz16 font-size: 16px;
.fz-sm ― font-size: small;
.pb-md ― padding-bottom: 1.0rem; (default value)
.ml-lg ― margin-left: 2.0rem; (default value)

See emma.css (all classes)

Emma.css only:

<article class="cf">
  <img class="d-b fl-l w-a mr-xl bdrs3" src="foo.png">
  <div class="fl-l ml-lg p-md">
    <h1 class="m0 ff-t">Title</h1>
    <p class="wow-bw wfsm-a">Description</p>
    <a class="d-ib fz-sm lh2" href="#">Read more</a>
  </div>
</article>

SUIT CSS naming convention + Emma.css (set prefix u-):

<article class="Excerpt u-cf">
  <img class="Excerpt-thumbnail u-d-b u-fl-l u-w-a" src="foo.png">
  <div class="u-fl-l u-ml-lg u-p-md">
    <h1 class="Excerpt-title">Title</h1>
    <p class="u-wow-bw u-wfsm-a">Description</p>
    <a class="Excerpt-readMore" href="#">Read more</a>
  </div>
</article>

Installation

Install or download Emma.css from one of these sources.

npm install emma.css

Rails (RubyGems)

gem install emma-css-rails

Download

https://github.com/ruedap/emma.css/releases

Alfred

https://github.com/ruedap/alfred-emma-css-workflow

Getting Started

Basic usage

SCSS:

@import "emma.css/scss/all";

CSS output:

.pos-s { position: static !important; }
.pos-a { position: absolute !important; }
.pos-r { position: relative !important; }
(snip)

Add prefix to utility classes

You can add prefix to utility classes by $emma-prefix variable:

$emma-prefix: "u-"; // Set prefix
@import "emma.css/scss/all";

CSS output:

.u-pos-s { position: static !important; }
.u-pos-a { position: absolute !important; }
.u-pos-r { position: relative !important; }
(snip)

Remove !important annotations

You can remove !important annotations by $emma-important variable:

$emma-important: false; // Remove !important annotations
@import "emma.css/scss/all";

CSS output:

.pos-s { position: static; }
.pos-a { position: absolute; }
.pos-r { position: relative; }
(snip)

Change default sizes or colors

You can change default sizes or colors by variables:

$emma-padding-md: 20px;  // default: `1.0rem`
$emma-color-black: #000; // default: `#111111`
@import "emma.css/scss/all";

License

Released under the MIT license.

Author

ruedap