Quantum CSS

![npm version](https://www.npmjs.com/package/quantum-css)
![travis ci status](https://travis-ci.org/Grabr/quantum-css)

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

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][1].

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):

``html`

`sass .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][1] 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.

`Contents`

1. Naming Conventions

- Value Aliases - Color Values - Unit-less Properties

1. Breakpoints

1. Pseudo-classes and Pseudo-elements

1. Grid System

- Containers - Rows - Columns - Column Ordering

1. Atom Index

- Name Pattern

- Backgroundbackground-colorbackground-attachmentbackground-clipbackground-imagebackground-originbackground-repeatbackground-sizebackground-positionbackground-position-xbackground-position-yfill- Borderborder-colorborder-top-colorborder-right-colorborder-bottom-colorborder-left-colorborder-widthborder-top-widthborder-right-widthborder-bottom-widthborder-left-widthborder-styleborder-top-styleborder-right-styleborder-bottom-styleborder-left-styleborder-radiusborder-top-right-radiusborder-top-left-radiusborder-bottom-right-radiusborder-bottom-left-radius- Imagesobject-fit

- Transformstransform

- Flexible Box Layoutflex-directionflex-wrapflex-growflex-shrinkflex-basisjustify-contentalign-itemsalign-contentalign-selforder- Positioningfloatclearpositiontoprightbottomleftz-index- Fontsfont-sizeline-heightfont-familyfont-weightfont-stylefont-variantfont-size-adjustfont-stretch-webkit-font-smoothing-moz-osx-font-smoothing- Transitionstransition-propertytransition-durationtransition-timing-function

- Textletter-spacingoverflow-wraptext-aligntext-align-lasttext-indenttext-decorationtext-transformwhite-spaceword-breakword-wrap- Lists and Counterslist-stylelist-style-positionlist-style-type- Colorscoloropacity- Box Modelbox-sizingheightwidthmarginpaddingoverflowoverflow-xoverflow-y-webkit-overflow-scrollingvisibility- Pagepage-break-beforepage-break-insidepage-break-after- User Interfacecursorresizetext-overflowuser-select- Tableborder-collapsecaption-sideempty-cellstable-layoutvertical-align- Miscellaneousdisplay1. License

`Naming Conventions`

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

1. Optional breakpoint name: SM, MDetc. 1. Property abbreviation: bdtc, ws etc. 1. Value abbreviation:w, 100p, 360detc. 1. 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.

`$3`

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 }

`$3`

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 ---------------- | --------- 1. Whitew | #fff2. Grey 15%g1 | #eeeeec3. Grey 30%g2 | #d3d7cf4. Grey 45%g3 | #babdb65. Grey 60%g4 | #888a856. Grey 75%g5 | #5557537. Grey 90%g6 | #2e34368. Blackb | #000

Color | Light l | Medium | Dark d----------------- | --------- | --------- | --------- 9. Yellowy | #fce94f | #edd400 | #c4a00010. Orangeo | #fcaf3e | #f57900 | #ce5c0011. Chocolatec | #e9b96e | #c17d11 | #8f590212. Greeng | #8ae234 | #73d216 | #4e9a0613. Navyn | #729fcf | #3465a4 | #204a8714. Purplep | #ad7f8a | #75507b | #5c356615. Redr | #ef2929 | #cc0000 | #a40000

CSS-literal colors:

- cc → currentColor-t → transparent-i → inherit

Generated atom examples:

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

`$3`

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.

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

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

Space-separated list defines selector conjunction:

`sass $pseudos: (eh: empty hover);

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

Combine those different list types for precise class targeting:

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

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

`Grid System`

`$3`

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.

`html

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

`$3`

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

`html



$3
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.

`html



$3
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.

`html



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

$3

- (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.

`$3`

####background-color

[breakpoint\_]bgc{key}[-pseudo] → background-color: {value}

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

####background-attachment

1. bga-f → fixed1. bga-s →scroll

####background-clip

1. bgcp-bb → border-box1. bgcp-pb →padding-box1. bgcp-cb →content-box1. bgcp-i →inherit

####background-image

1. bgi-n → none1. bgi-i →inherit

####background-origin

1. bgo-bb → border-box1. bgo-pb →padding-box1. bgo-cb →content-box

####background-repeat

1. bgr-n → no-repeat1. bgr-x →repeat-x1. bgr-y →repeat-y1. bgr-s →space1. bgr-r →round

####background-size

1. bgz-a → auto1. bgz-ct →contain1. bgz-cv →cover

####background-position

1. bgp-tc → top center1. bgp-tl →top left1. bgp-cr →center right1. bgp-cc →center center1. bgp-cl →center left1. bgp-br →bottom right1. bgp-bc →bottom center1. bgp-bl →bottom left

####background-position-x

1. bgpx-r → right1. bgpx-c →center1. bgpx-l →left

####background-position-y

1. bgpy-t → top1. bgpy-c →center1. bgpy-b →bottom

####fill

[breakpoint\_]fi{key}[-pseudo] → fill: {value}

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

`$3`

####border-color

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

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

####border-width

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

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

####border-style

1. [breakpoint\_]bds{key} → border-style: {value}1. [breakpoint\_]bdxs{key} = bdls{key}, bdrs{key} 1. [breakpoint\_]bdys{key} = bdts{key}, bdbs{key} 1. [breakpoint\_]bdts{key} →border-top-style: {value}1. [breakpoint\_]bdbs{key} →border-bottom-style: {value}1. [breakpoint\_]bdrs{key} →border-right-style: {value}1. [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.

#### border-radius

1. [breakpoint\_]bdr{key} → border-radius: {value}1. [breakpoint\_]bdtr{key} = bdtlr{key}, bdtrr{key} 1. [breakpoint\_]bdrr{key} = bdtrr{key}, bdbrr{key} 1. [breakpoint\_]bdbr{key} = bdblr{key}, bdbrr{key} 1. [breakpoint\_]bdlr{key} = bdtlr{key}, bdblr{key} 1. [breakpoint\_]bdtrr{key} →border-top-right-radius: {value}1. [breakpoint\_]bdtlr{key} →border-top-left-radius: {value}1. [breakpoint\_]bdbrr{key} →border-bottom-right-radius: {value}1. [breakpoint\_]bdblr{key} →border-bottom-left-radius: {value}

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

`$3`

####object-fit

1. of-n → none1. of-f →fill1. of-ct →contain1. of-cv →cover1. of-sd →scale-down1. of-i →inherit

`$3`

####transform

1. ts-n → none1. ts-i →inherit1. tsr(45d…360/45d) →transform: rotate(45deg)…rotate(360deg)1. tsr(-45d…-360/-45d) →transform: rotate(-45deg)…rotate(-360deg)1. tss(0…200/25) →transform: scale(0)…scale(2)

`$3`


These shortcuts are available if display atom is included.
1. [breakpoint\_]fx-r  = d-fx, fxd-r
1. [breakpoint\_]fx-rr = d-fx, fxd-rr
1. [breakpoint\_]fx-c  = d-fx, fxd-c
1. [breakpoint\_]fx-cr = d-fx, fxd-cr

####flex-direction

1. [breakpoint\_]fxd-r → row1. [breakpoint\_]fxd-rr →row-reverse1. [breakpoint\_]fxd-c →column1. [breakpoint\_]fxd-cr →column-reverse

####flex-wrap

1. [breakpoint\_]fxw-n → nowrap1. [breakpoint\_]fxw-w →wrap1. [breakpoint\_]fxw-wr →wrap-reverse

####flex-grow

[breakpoint\_]fxg(0…10/1) → flex-grow: 0…10

####flex-shrink

[breakpoint\_]fxs(0…10/1) → flex-shrink: 0…10

####flex-basis

1. [breakpoint\_]fxb-a → auto1. [breakpoint\_]fxb-mac →max-content1. [breakpoint\_]fxb-mic →min-content1. [breakpoint\_]fxb-fc →fit-content1. [breakpoint\_]fxb-c →content

####justify-content

1. [breakpoint\_]jc-fs → flex-start1. [breakpoint\_]jc-fe →flex-end1. [breakpoint\_]jc-c →center1. [breakpoint\_]jc-sb →space-between1. [breakpoint\_]jc-sa →space-around

####align-items

1. [breakpoint\_]ai-fs → flex-start1. [breakpoint\_]ai-fe →flex-end1. [breakpoint\_]ai-c →center1. [breakpoint\_]ai-bs →baseline1. [breakpoint\_]ai-s →stretch

####align-content

1. [breakpoint\_]ac-fs → flex-start1. [breakpoint\_]ac-fe →flex-end1. [breakpoint\_]ac-c →center1. [breakpoint\_]ac-sb →space-between1. [breakpoint\_]ac-sa →space-around1. [breakpoint\_]ac-s →stretch

####align-self

1. [breakpoint\_]as-a → auto1. [breakpoint\_]as-fs →flex-start1. [breakpoint\_]as-fe →flex-end1. [breakpoint\_]as-c →center1. [breakpoint\_]as-b →baseline1. [breakpoint\_]as-s →stretch

####order

[breakpoint\_]ord(0…10/1) → order: 0…10

`$3`

####float

1. [breakpoint\_]fl-l → left1. [breakpoint\_]fl-r →right1. [breakpoint\_]fl-n →none

####clear

1. cl-l → left1. cl-r →right1. cl-b →both1. cl-n →none

####position

1. pos-s → static1. pos-a →absolute1. pos-r →relative1. pos-f →fixed

####top right bottom left

1. [breakpoint\_]t{key} → top: {value}1. [breakpoint\_]r{key} →right: {value}1. [breakpoint\_]b{key} →bottom: {value}1. [breakpoint\_]l{key} →left: {value}

Specify mapping in $positions: (key: value).

####z-index

1. z(0…10/1) → z-index: 0…101. z-a →auto1. z-i →inherit

`$3`

####font-size

1. [breakpoint\_]fz-xxs → xx-small1. [breakpoint\_]fz-xs →x-small1. [breakpoint\_]fz-s →small1. [breakpoint\_]fz-m →medium1. [breakpoint\_]fz-l →large1. [breakpoint\_]fz-xl →x-large1. [breakpoint\_]fz-xxl →xx-large1. [breakpoint\_]fz-lr →larger1. [breakpoint\_]fz-sr →smaller1. [breakpoint\_]fz-i →inherit1. [breakpoint\_]fz{key} →font-size: {value}

Specify mapping in $font-sizes: (key: value).

####line-height

1. lh-n → normal1. lh-i →inherit1. lh0 →01. lh1 →11. lh{key} →line-height: {value}

Specify mapping in $line-heights: (key: value).

####font-family

1. [breakpoint\_]fs-s → serif1. [breakpoint\_]fs-ss →sans-serif1. [breakpoint\_]fs-m →monospace1. [breakpoint\_]fs-c →cursive1. [breakpoint\_]fs-f →fantasy1. [breakpoint\_]fs-i →inherit1. [breakpoint\_]fs{key} →font-family: {value}

Specify mapping in $font-families: (key: value).

####font-weight

1. [breakpoint\_]fw(100…900/100) → font-weight: 100…9001. [breakpoint\_]fw-n →normal1. [breakpoint\_]fw-b →bold1. [breakpoint\_]fw-br →bolder1. [breakpoint\_]fw-lr →lighter1. [breakpoint\_]fw-i →inherit

####font-style

1. [breakpoint\_]fs-n → normal1. [breakpoint\_]fs-i →italic1. [breakpoint\_]fs-o →oblique

####font-variant

1. fv-cl → common-ligatures1. fv-apc →all-petite-caps1. fv-asc →all-small-caps1. fv-sc →small-caps1. fv-c →contextual1. fv-df →diagonal-fractions1. fv-sf →stacked-fractions1. fv-hf →historical-forms1. fv-hl →historical-ligatures1. fv-i →inherit1. fv-n →normal1. fv-tn →tabular-nums1. fv-pn →proportional-nums1. fv-pw →proportional-width

####font-size-adjust

fza-n → none

####font-stretch

1. fst-n → normal1. fst-uc →ultra-condensed1. fst-ec →extra-condensed1. fst-c →condensed1. fst-sc →semi-condensed1. fst-se →semi-expanded1. fst-e →expanded1. fst-ee →extra-expanded1. fst-ue →ultra-expanded

####-webkit-font-smoothing

1. wfsm-a → antialiased1. wfsm-sa →subpixel-antialiased1. wfsm-n →none

####-moz-osx-font-smoothing

1. mfsm-a → auto1. mfsm-g →grayscale

`$3`

####transition-property

1. trp-n → none1. trp-a →all

####transition-duration

trd(100ms…1000ms/100ms) → transition-duration: 100ms…1000ms

####transition-timing-function

1. trtf-e → ease1. trtf-ei →ease-in1. trtf-eo →ease-out1. trtf-eio →ease-in-out1. trtf-l →linear1. trtf-ss →step-start1. trtf-se →step-end

`$3`

####letter-spacing

1. ls-n → normal1. ls-i →inherit1. ls{key} →letter-spacing: {value}

Specify mapping in $letter-spacings: (key: value).

####overflow-wrap

1. ovw-n → normal1. ovw-b →break-word

####text-align

1. [breakpoint\_]ta-l → left1. [breakpoint\_]ta-c →center1. [breakpoint\_]ta-r →right1. [breakpoint\_]ta-j →justify

####text-align-last

1. [breakpoint\_]tal-l → left1. [breakpoint\_]tal-c →center1. [breakpoint\_]tal-r →right1. [breakpoint\_]tal-j →justify

####text-indent

ti{key} → text-indent: {value}

Specify mapping in $text-indents: (key: value).

####text-decoration

1. [breakpoint\_]td-n[-pseudo] → none1. [breakpoint\_]td-u[-pseudo] →underline1. [breakpoint\_]td-o →overline1. [breakpoint\_]td-lt →line-through

####text-transform

1. tt-c → capitalize1. tt-u →uppercase1. tt-l →lowercase1. tt-n →none1. tt-fw →full-width

####white-space

1. [breakpoint\_]ws-n → normal1. [breakpoint\_]ws-p →pre1. [breakpoint\_]ws-nw →nowrap1. [breakpoint\_]ws-pw →pre-wrap1. [breakpoint\_]ws-pl →pre-line

####word-break

1. wob-n → normal1. wob-ka →keep-all1. wob-ba →break-all

####word-wrap

1. wow-n → normal1. wow-bw →break-word

`$3`

####list-style

1. lis-n → none1. lis-i →inherit

####list-style-position

1. lisp-in → inside1. lisp-o →outside1. lisp-i →inherit

####list-style-type

1. list-n → none1. list-d →disc1. list-c →circle1. list-s →square1. list-dc →decimal1. list-dclz →decimal-leading-zero1. list-lr →lower-roman1. list-ur →upper-roman1. list-i →inherit

`$3`

####color

[breakpoint\_]c{key}[-pseudo] → color: {value}

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

####opacity

op(0…100/1) → opacity: 0…1

`$3`

####box-shadow

bxs{key}[-pseudo] → box-shadow: {value}

Specify mapping in $box-shadows: (key: value).

####box-sizing

1. bxz-cb → content-box1. bxz-bb →border-box1. bxz-i →inherit

####height

1. [breakpoint\_]h{key} → height: {value}1. [breakpoint\_]mah-n →max-height: none1. [breakpoint\_]mah{key} →max-height: {value}1. [breakpoint\_]mih{key} →min-height: {value}

Specify mapping in $heights: (key: value).

####width

1. [breakpoint\_]w{key} → width: {value}1. [breakpoint\_]maw-n →max-width: none1. [breakpoint\_]maw{key} →max-width: {value}1. [breakpoint\_]miw{key} →min-width: {value}

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

####margin

1. [breakpoint\_]m{key} → margin: {value}1. [breakpoint\_]mx-a →margin-left: auto, margin-right: auto1. [breakpoint\_]mx{key} = ml{key}, mr{key} 1. [breakpoint\_]my{key} = mt{key}, mb{key} 1. [breakpoint\_]mt{key} →margin-top: {value}1. [breakpoint\_]mr{key} →margin-right: {value}1. [breakpoint\_]mb{key} →margin-bottom: {value}1. [breakpoint\_]ml{key} →margin-left: {value}

Specify mapping in $margins: (key: value).

####padding

1. [breakpoint\_]p{key} → padding: {value}1. [breakpoint\_]px{key} = pl{key}, pr{key} 1. [breakpoint\_]py{key} = pt{key}, pb{key} 1. [breakpoint\_]pt{key} →padding-top: {value}1. [breakpoint\_]pr{key} →padding-right: {value}1. [breakpoint\_]pb100p →padding-bottom: 100%1. [breakpoint\_]pb{key} →padding-bottom: {value}1. [breakpoint\_]pl{key} →padding-left: {value}

Specify mapping in $paddings: (key: value).

####overflow

1. ov-v → visible1. ov-h →hidden1. ov-s →scroll1. ov-a →auto

####overflow-x

1. ovx-v → visible1. ovx-h →hidden1. ovx-s →scroll1. ovx-a →auto

####overflow-y

1. ovy-v → visible1. ovy-h →hidden1. ovy-s →scroll1. ovy-a →auto

####-webkit-overflow-scrolling

1. wovs-t → touch1. wovs-a →auto

####visibility

1. [breakpoint\_]v-v → visible1. [breakpoint\_]v-h →hidden1. [breakpoint\_]v-c →collapse

`$3`

####page-break-before

1. pgbb-a → auto1. pgbb-al →always1. pgbb-av →avoid1. pgbb-l →left1. pgbb-r →right

####page-break-inside

1. pgbi-a → auto1. pgbi-av →avoid

####page-break-after

1. pgba-a → auto1. pgba-al →always1. pgba-av →avoid1. pgba-l →left1. pgba-r →right

`$3`

####cursor

1. cur-a → auto1. cur-d →default1. cur-cm →context-menu1. cur-h →help1. cur-p →pointer1. cur-ps →progress1. cur-w →wait1. cur-cl →cell1. cur-c →crosshair1. cur-t →text1. cur-al →alias1. cur-cp →copy1. cur-m →move1. cur-nd →no-drop1. cur-na →not-allowed1. cur-as →all-scroll1. cur-cr →col-resize1. cur-rr →row-resize1. cur-nr →n-resize1. cur-er →e-resize1. cur-sr →s-resize1. cur-wr →w-resize1. cur-ner →ne-resize1. cur-nwr →nw-resize1. cur-ser →se-resize1. cur-swr →sw-resize1. cur-ewr →ew-resize1. cur-nsr →ns-resize1. cur-neswr →nesw-resize1. cur-nwser →nwse-resize1. cur-zi →zoom-in1. cur-zo →zoom-out1. cur-g →grab1. cur-gr →grabbing1. cur-n →none

####resize

1. rz-n → none1. rz-b →both1. rz-h →horizontal1. rz-v →vertical

####text-overflow

1. tov-e → ellipsis1. tov-c →clip

####user-select

1. us-n → none1. us-t →text1. us-a →all

`$3`

####border-collapse

1. bdce-c → collapse1. bdce-s →separate1. bdce-i →inherit

####caption-side

1. cps-t → top1. cps-b →bottom

####empty-cells

1. ec-s → show1. ec-h →hide

####table-layout

1. tbl-a → auto1. tbl-f →fixed

####vertical-align

1. va-sp → super1. va-t →top1. va-tt →text-top1. va-m →middle1. va-bs →baseline1. va-b →bottom1. va-tb →text-bottom1. va-sb →sub

`$3`

####display

1. d-n → none1. d-b →block1. d-fx →flex1. d-li →list-item1. d-ri →run-in1. d-i →inline1. d-itb →inline-table1. d-ifx →inline-flex1. d-ib →inline-block1. d-tb →table1. d-tcp →table-caption1. d-tc →table-column1. d-tcg →table-column-group1. d-thg →table-header-group1. d-tfg →table-footer-group1. d-tr →table-row1. d-trg →table-row-group1. d-tcl →table-cell1. d-rb →ruby1. d-rbb →ruby-base1. d-rbbc →ruby-base-container1. d-rbt →ruby-text1. d-rbtc →ruby-text-container`

License

The code is available under MIT licence.

[1]: http://sass-lang.com/documentation/file.SASS_REFERENCE.html#extend

Quantum CSS

![npm version](https://www.npmjs.com/package/quantum-css)
![travis ci status](https://travis-ci.org/Grabr/quantum-css)

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

Preface

Quantum CSS is an atomic CSS library written in SCSS.

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):

``html`

`sass .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][1] 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.

`Contents`

1. Naming Conventions

- Value Aliases - Color Values - Unit-less Properties

1. Breakpoints

1. Pseudo-classes and Pseudo-elements

1. Grid System

- Containers - Rows - Columns - Column Ordering

1. Atom Index

- Name Pattern

- Transformstransform

`Naming Conventions`

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

1. Optional breakpoint name: SM, MDetc. 1. Property abbreviation: bdtc, ws etc. 1. Value abbreviation:w, 100p, 360detc. 1. 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.

`$3`

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 }

`$3`

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.

CSS-literal colors:

- cc → currentColor-t → transparent-i → inherit

Generated atom examples:

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

`$3`

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.

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

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

Space-separated list defines selector conjunction:

`sass $pseudos: (eh: empty hover);

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

Combine those different list types for precise class targeting:

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

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

`Grid System`

`$3`

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.

`html

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

`$3`

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

`html



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

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.

`html



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

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.

`html



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

$3

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

`$3`

####background-color

[breakpoint\_]bgc{key}[-pseudo] → background-color: {value}

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

####background-attachment

1. bga-f → fixed1. bga-s →scroll

####background-clip

1. bgcp-bb → border-box1. bgcp-pb →padding-box1. bgcp-cb →content-box1. bgcp-i →inherit

####background-image

1. bgi-n → none1. bgi-i →inherit

####background-origin

1. bgo-bb → border-box1. bgo-pb →padding-box1. bgo-cb →content-box

####background-repeat

1. bgr-n → no-repeat1. bgr-x →repeat-x1. bgr-y →repeat-y1. bgr-s →space1. bgr-r →round

####background-size

1. bgz-a → auto1. bgz-ct →contain1. bgz-cv →cover

####background-position

####background-position-x

1. bgpx-r → right1. bgpx-c →center1. bgpx-l →left

####background-position-y

1. bgpy-t → top1. bgpy-c →center1. bgpy-b →bottom

####fill

[breakpoint\_]fi{key}[-pseudo] → fill: {value}

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

`$3`

####border-color

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

####border-width

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

####border-style

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

#### border-radius

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

`$3`

####object-fit

1. of-n → none1. of-f →fill1. of-ct →contain1. of-cv →cover1. of-sd →scale-down1. of-i →inherit

`$3`

####transform

`$3`


These shortcuts are available if display atom is included.
1. [breakpoint\_]fx-r  = d-fx, fxd-r
1. [breakpoint\_]fx-rr = d-fx, fxd-rr
1. [breakpoint\_]fx-c  = d-fx, fxd-c
1. [breakpoint\_]fx-cr = d-fx, fxd-cr

####flex-direction

1. [breakpoint\_]fxd-r → row1. [breakpoint\_]fxd-rr →row-reverse1. [breakpoint\_]fxd-c →column1. [breakpoint\_]fxd-cr →column-reverse

####flex-wrap

1. [breakpoint\_]fxw-n → nowrap1. [breakpoint\_]fxw-w →wrap1. [breakpoint\_]fxw-wr →wrap-reverse

####flex-grow

[breakpoint\_]fxg(0…10/1) → flex-grow: 0…10

####flex-shrink

[breakpoint\_]fxs(0…10/1) → flex-shrink: 0…10

####flex-basis

1. [breakpoint\_]fxb-a → auto1. [breakpoint\_]fxb-mac →max-content1. [breakpoint\_]fxb-mic →min-content1. [breakpoint\_]fxb-fc →fit-content1. [breakpoint\_]fxb-c →content

####justify-content

1. [breakpoint\_]jc-fs → flex-start1. [breakpoint\_]jc-fe →flex-end1. [breakpoint\_]jc-c →center1. [breakpoint\_]jc-sb →space-between1. [breakpoint\_]jc-sa →space-around

####align-items

1. [breakpoint\_]ai-fs → flex-start1. [breakpoint\_]ai-fe →flex-end1. [breakpoint\_]ai-c →center1. [breakpoint\_]ai-bs →baseline1. [breakpoint\_]ai-s →stretch

####align-content

####align-self

####order

[breakpoint\_]ord(0…10/1) → order: 0…10

`$3`

####float

1. [breakpoint\_]fl-l → left1. [breakpoint\_]fl-r →right1. [breakpoint\_]fl-n →none

####clear

1. cl-l → left1. cl-r →right1. cl-b →both1. cl-n →none

####position

1. pos-s → static1. pos-a →absolute1. pos-r →relative1. pos-f →fixed

####top right bottom left

1. [breakpoint\_]t{key} → top: {value}1. [breakpoint\_]r{key} →right: {value}1. [breakpoint\_]b{key} →bottom: {value}1. [breakpoint\_]l{key} →left: {value}

Specify mapping in $positions: (key: value).

####z-index

1. z(0…10/1) → z-index: 0…101. z-a →auto1. z-i →inherit

`$3`

####font-size

Specify mapping in $font-sizes: (key: value).

####line-height

1. lh-n → normal1. lh-i →inherit1. lh0 →01. lh1 →11. lh{key} →line-height: {value}

Specify mapping in $line-heights: (key: value).

####font-family

Specify mapping in $font-families: (key: value).

####font-weight

####font-style

1. [breakpoint\_]fs-n → normal1. [breakpoint\_]fs-i →italic1. [breakpoint\_]fs-o →oblique

####font-variant

####font-size-adjust

fza-n → none

####font-stretch

####-webkit-font-smoothing

1. wfsm-a → antialiased1. wfsm-sa →subpixel-antialiased1. wfsm-n →none

####-moz-osx-font-smoothing

1. mfsm-a → auto1. mfsm-g →grayscale

`$3`

####transition-property

1. trp-n → none1. trp-a →all

####transition-duration

trd(100ms…1000ms/100ms) → transition-duration: 100ms…1000ms

####transition-timing-function

1. trtf-e → ease1. trtf-ei →ease-in1. trtf-eo →ease-out1. trtf-eio →ease-in-out1. trtf-l →linear1. trtf-ss →step-start1. trtf-se →step-end

`$3`

####letter-spacing

1. ls-n → normal1. ls-i →inherit1. ls{key} →letter-spacing: {value}

Specify mapping in $letter-spacings: (key: value).

####overflow-wrap

1. ovw-n → normal1. ovw-b →break-word

####text-align

1. [breakpoint\_]ta-l → left1. [breakpoint\_]ta-c →center1. [breakpoint\_]ta-r →right1. [breakpoint\_]ta-j →justify

####text-align-last

1. [breakpoint\_]tal-l → left1. [breakpoint\_]tal-c →center1. [breakpoint\_]tal-r →right1. [breakpoint\_]tal-j →justify

####text-indent

ti{key} → text-indent: {value}

Specify mapping in $text-indents: (key: value).

####text-decoration

1. [breakpoint\_]td-n[-pseudo] → none1. [breakpoint\_]td-u[-pseudo] →underline1. [breakpoint\_]td-o →overline1. [breakpoint\_]td-lt →line-through

####text-transform

1. tt-c → capitalize1. tt-u →uppercase1. tt-l →lowercase1. tt-n →none1. tt-fw →full-width

####white-space

1. [breakpoint\_]ws-n → normal1. [breakpoint\_]ws-p →pre1. [breakpoint\_]ws-nw →nowrap1. [breakpoint\_]ws-pw →pre-wrap1. [breakpoint\_]ws-pl →pre-line

####word-break

1. wob-n → normal1. wob-ka →keep-all1. wob-ba →break-all

####word-wrap

1. wow-n → normal1. wow-bw →break-word

`$3`

####list-style

1. lis-n → none1. lis-i →inherit

####list-style-position

1. lisp-in → inside1. lisp-o →outside1. lisp-i →inherit

####list-style-type

`$3`

####color

[breakpoint\_]c{key}[-pseudo] → color: {value}

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

####opacity

op(0…100/1) → opacity: 0…1

`$3`

####box-shadow

bxs{key}[-pseudo] → box-shadow: {value}

Specify mapping in $box-shadows: (key: value).

####box-sizing

1. bxz-cb → content-box1. bxz-bb →border-box1. bxz-i →inherit

####height

1. [breakpoint\_]h{key} → height: {value}1. [breakpoint\_]mah-n →max-height: none1. [breakpoint\_]mah{key} →max-height: {value}1. [breakpoint\_]mih{key} →min-height: {value}

Specify mapping in $heights: (key: value).

####width

1. [breakpoint\_]w{key} → width: {value}1. [breakpoint\_]maw-n →max-width: none1. [breakpoint\_]maw{key} →max-width: {value}1. [breakpoint\_]miw{key} →min-width: {value}