0.1.0 • Published 8 years ago

suitcss-components-module v0.1.0

Weekly downloads
7
License
-
Repository
github
Last release
8 years ago

SUIT Module

Build Status

A SUIT component for OOCSS Module / Section layouts – inspired by Nicole Sullivan's Module component.

Read more about SUIT's design principles.

Installation

  • npm: npm install suitcss-components-module
  • Download: releases

Available classes

  • Module - The core class
  • Module-block - A block unit, can contain headers, content, footers etc.
  • Module-block--separated - Separates a Module-block from the Module-block above
  • Module--withGutter[Sm|Lg] – Adds vertical spacing between Module-block where Sm = small, Lg = large
  • Module--withPadding[Sm|Lg] – Adds inner spacing to each Module-block where Sm = small, Lg = large

Configurable variables

Gutter is the vertical space between Module-block(s)

--Module-gutter
--Module-gutter-sm
--Module-gutter-lg

Padding for the Module-block

--Module-padding
--Module-padding-sm
--Module-padding-lg

Separator border for the Module-block

--Module-block-separated-borderColor

Usage

<div class="Module">
  <div class="Module-block">...</div>
  <div class="Module-block">...</div>
  ...
</div>

See the test file for more examples.

Testing

Install Node (comes with npm).

npm install

To generate a build:

npm run build

To generate the testing build.

npm run build-test

Basic visual tests are in test/index.html.

To pre-process:

npm run preprocess

To pre-process the tests:

npm run preprocess-test

Browser support

  • Google Chrome (latest)
  • Opera (latest)
  • Firefox 4+
  • Safari 5+
  • Internet Explorer 8+