quantum-css

v0.0.36

Published

2 years ago

Functional CSS library in SCSS

Downloads

0High
0Medium
0Low

opportunato

alexander-matsievsky

smikhalevski

SASS SCSS CSS functional atomic

Quantum CSS

“Everything should be made as simple as possible, but no simpler.” – Albert Einstein 1

Preface

Quantum CSS is an atomic CSS library written in SCSS.

You won’t need to write any CSS rules and media queries while using Quantum CSS. Creating highly responsive UIs becomes pleasure while extension pattern provides means of controlled customization. You can create molecules with avaialble atoms using @extend.

Here is a sample button component with rounded corners, hover and focus transition animations (which are disabled on small screens to provide better experience on touch devices):

<button class="btn btn-fb" type="button">
  <!-- Content -->
</button>

.btn {
  @extend .px15, .h40; // Size
  @extend .bds-s, .bdw1, .bdr5; // Border style solid, border width 1px and rounded corners
  @extend .trp-c, .trd200ms; // Color transitions

  &-fb  { @extend .bgc-fb, .c-w, .bdc-tt, .SM_bgc-dfb-hf } // Facebook
  &-tw  { @extend .bgc-tw, .c-w, .bdc-tt, .SM_bgc-dtw-hf } // Twitter
}

Benefits of using @extend approach:

Highly standardized styles. Limited amount of building blocks allows you to have more order in your design.
Stylesheet compilation time errors. Build fails if unknown atoms are used.
Easy to remember class names. Atoms naming convention was heavily inspired by Emmet, and most of the time abbreviations are first letters of words that property or value names consist of.

Naming Conventions

Atom Index

License

Naming Conventions

In Quantum CSS every class name consists of four parts in given order:

Optional breakpoint name: SM, MD etc.
Property abbreviation: bdtc, ws etc.
Value abbreviation: w, 100p, 360d etc.
Optional pseudo-class or pseudo-element modifier: hf, h etc.

You can configure separators between each parts of class name with following variables:

$breakpoint-sep define separator between breakpoint name and property abbreviation.
$literal-sep and $ordinal-sep define separators that are inserted between property name and literal value abbreviation or ordinal one respectively.
$pseudo-sep defines separator between pseudo modifier from value abbreviation.

Value Aliases

Aliases for commonly used values:

p → %
e → em
x → ex
r → rem
d → deg
t → turn

These aliases are used instead of full units:

w100p → width: 100%
SM_mah42 → @media (min-width: 576px) { max-height: 42px }

Color Values

Names for colors are used fo increase readability. By default, Tango palette is used for every color-related atom. You can specify your own palette overriding variables in _variables.scss.

Greyscale | Value ---------------- | ---------

White w | #fff
Grey 15% g1 | #eeeeec
Grey 30% g2 | #d3d7cf
Grey 45% g3 | #babdb6
Grey 60% g4 | #888a85
Grey 75% g5 | #555753
Grey 90% g6 | #2e3436
Black b | #000

Color | Light l | Medium | Dark d ----------------- | --------- | --------- | --------- 9. Yellow y | #fce94f | #edd400 | #c4a000 10. Orange o | #fcaf3e | #f57900 | #ce5c00 11. Chocolate c | #e9b96e | #c17d11 | #8f5902 12. Green g | #8ae234 | #73d216 | #4e9a06 13. Navy n | #729fcf | #3465a4 | #204a87 14. Purple p | #ad7f8a | #75507b | #5c3566 15. Red r | #ef2929 | #cc0000 | #a40000

CSS-literal colors:

cc → currentColor
t → transparent
i → inherit

Generated atom examples:

SM_bgc-dg → background-color: #4e9a06 Dark green
bdrc-w → border-right-color: white
LG_c-b → color: black

Unit-less Properties

Some CSS properties are defined as unit-less, e.g. no unit suffix will be outputted:

lh1 → line-height: 1
fw400 → font-weight: 400
op37 → opacity: 0.37

Breakpoints

One of the most powerful features of Quantum is breakpoint-based media queries.

Pseudo-classes and Pseudo-elements

You can configure set of pseudo-classes and pseudo-elements for which atoms are generated via $pseudos. To emit disjunction of pseudos use comma-separated list.

$pseudos: (hf: (hover, focus));

.c-w-hf:hover,
.c-w-hf:focus {
  color: white;
}

Space-separated list defines selector conjunction:

$pseudos: (eh: empty hover);

.c-w-eh:empty:hover {
  color: white;
}

Combine those different list types for precise class targeting:

$pseudos: (foo: (active hover, active focus));

.c-w-foo:active:hover,
.c-w-foo:active:focus {
  color: white;
}

Grid System

Containers g

As well as in Bootstrap Containers are the most basic layout element and are required when using grid system. Use g-f to create a fixed-width centered responsive layout of columns.

While containers can be nested, most layouts do not require a nested container.

<div class="g g-f">
  <!-- Fixed-width grid conteiner -->
</div>

Widths of fixed-width container are stored in $grid-widths.

Rows gr

Rows are horizontal groups of columns that ensure your columns are lined up properly.

<div class="g g-f">
  <div class="gr">
    <!-- Place columns here -->
  </div>
</div>

Columns gc

Content should be placed within columns, and only columns may be immediate children of rows.

Column classes indicate the number of columns you’d like to use out of the possible 12 per row. So if you want three equal-width columns, you’d use SM_gc4. You can change number of columns in grid altering $grid-col-count.

Column widths are set in percentages, so they’re always fluid and sized relative to their parent element.

Columns have horizontal padding to create the gutters between individual columns. Gutters can be configured per every breakpoint via $grid-gutters.

<div class="g g-f">
  <div class="gr">
    <div class="gc12 SM_gc6">
      <!-- Place content here -->
    </div>
  </div>
</div>

Column Ordering

In addition to column clearing at responsive breakpoints, you may need to reset offsets, pushes, or pulls.

Move columns to the right using [breakpoint_]go(0…12/1) classes. These classes increase the left margin of a column by specified number of columns. For example, MD_go4 moved MD_gc4 over four columns.

Change the order of columns by relatively shifting them to the left with [breakpoint_]gsl(0…12/1) or to the right with [breakpoint_]gsr(0…12/1) classes.

<div class="g g-f">
  <div class="gr">
    <div class="gc12 SM_gc6 SM_go3">
      <!-- Place content here -->
    </div>
  </div>
</div>

Atom Index

Values for each atom are listed in the order they are listed in generated CSS.

Name Pattern

(1…10/2) Range of possible values from 1 to 10 with step 2.
[breakpoint_] and [-pseudo] Optional breakpoint and pseudo-element or pseudo-class.
{key} and {value} Placeholders for map key and map value.

Example [breakpoint_]fw(100…900/100) expands to fw100, fw200 … SM_fw100, SM_fw200 … LG_fw900.

Background

`background-color`

[breakpoint_]bgc{key}[-pseudo] → background-color: {value}

Specify mapping in $background-colors: (key: value).

`background-attachment`

bga-f → fixed
bga-s → scroll

`background-clip`

bgcp-bb → border-box
bgcp-pb → padding-box
bgcp-cb → content-box
bgcp-i → inherit

`background-image`

bgi-n → none
bgi-i → inherit

`background-origin`

bgo-bb → border-box
bgo-pb → padding-box
bgo-cb → content-box

`background-repeat`

bgr-n → no-repeat
bgr-x → repeat-x
bgr-y → repeat-y
bgr-s → space
bgr-r → round

`background-size`

bgz-a → auto
bgz-ct → contain
bgz-cv → cover

`background-position`

bgp-tc → top center
bgp-tl → top left
bgp-cr → center right
bgp-cc → center center
bgp-cl → center left
bgp-br → bottom right
bgp-bc → bottom center
bgp-bl → bottom left

`background-position-x`

bgpx-r → right
bgpx-c → center
bgpx-l → left

`background-position-y`

bgpy-t → top
bgpy-c → center
bgpy-b → bottom

`fill`

[breakpoint_]fi{key}[-pseudo] → fill: {value}

Specify mapping in $background-colors: (key: value).

Border

`border-color`

[breakpoint_]bdc{key}[-pseudo] → border-color: {value}
[breakpoint_]bdxc{key}[-pseudo] = bdlc{key}, bdrc{key}
[breakpoint_]bdyc{key}[-pseudo] = bdtc{key}, bdbc{key}
[breakpoint_]bdtc{key}[-pseudo] → border-top-color: {value}
[breakpoint_]bdbc{key}[-pseudo] → border-bottom-color: {value}
[breakpoint_]bdrc{key}[-pseudo] → border-right-color: {value}
[breakpoint_]bdlc{key}[-pseudo] → border-left-color: {value}

Specify mapping in $border-colors: (key: value).

`border-width`

[breakpoint_]bdw{key} → border-width: {value}
[breakpoint_]bdxw{key} = bdlw{key}, bdrw{key}
[breakpoint_]bdyw{key} = bdtw{key}, bdbw{key}
[breakpoint_]bdtw{key} → border-top-width: {value}
[breakpoint_]bdbw{key} → border-bottom-width: {value}
[breakpoint_]bdrw{key} → border-right-width: {value}
[breakpoint_]bdlw{key} → border-left-width: {value}

Specify mapping in $border-widths: (key: value).

`border-style`

[breakpoint_]bds{key} → border-style: {value}
[breakpoint_]bdxs{key} = bdls{key}, bdrs{key}
[breakpoint_]bdys{key} = bdts{key}, bdbs{key}
[breakpoint_]bdts{key} → border-top-style: {value}
[breakpoint_]bdbs{key} → border-bottom-style: {value}
[breakpoint_]bdrs{key} → border-right-style: {value}
[breakpoint_]bdls{key} → border-left-style: {value}

Specify mapping in $border-styles: (key: value).

By default, all available border styles are included. Border style atoms are emitted for every breakpoint what can cause significant increase of outputted CSS file. Be sure to remove unused border styles in order to reduce file size.