SUIT CSS

Style tools for component-based UI development.

SUIT CSS provides a reliable and testable styling solution for component-based web application development. The project includes:

Each of these modules are made up of smaller modules, making it easy to customize your setup and build pipeline.

Documentation.

Example

SUIT CSS makes use of variables, custom media queries, and dependency resolution for CSS.

HTML:

<article class="Excerpt u-cf">
  <img class="Excerpt-thumbnail u-sizeFit" src="{{src}}" alt="">
  <div class="u-sizeFill">
    <h1 class="Excerpt-title"><a href="{{url}}">{{title}}</a></h1>
    <p class="Excerpt-text u-textBreak">{{description}}</p>
    <span class="Excerpt-readMore">
      <!-- BUTTON COMPONENT -->
    </span>
  </div>
</article>

CSS:

/** @define Excerpt; use strict */

@import "suitcss-utils-layout";
@import "suitcss-utils-size";
@import "suitcss-utils-text";
@import "./Button";

/**
 * Content excerpts. Agnostic of image size, and with a clear call to action.
 */

:root {
  --Excerpt-padding: 20px;
  --Excerpt-highlight-color: orange;
}

.Excerpt {
  padding: var(--Excerpt-padding);
}

.Excerpt-thumbnail {
  border: 2px solid var(--Excerpt-highlight-color);
  border-radius: 3px;
  margin-right: 10px;
}

.Excerpt-title {
  border-bottom: 1px solid #ccc;
  margin: 0 0 15px;
  padding-bottom: 5px;
}

.Excerpt-readMore {
  display: inline-block;
  margin-top: 10px;
}

CSS packages

Each CSS package can be installed with npm, Component(1), or Bower. It's suggested that you depend on individual packages as and when you need them, however, you can install all the CSS packages at once if you prefer:

npm: npm install suitcss
Component(1): component install suitcss/suit
Bower: bower install suit

Each package is stand-alone, contains its own documentation and tests, and is written to follow a common set of naming conventions.

base: a thin reset for web apps, built on top of normalize.css.
utils: all the utility packages.
components-arrange: flexbox-like horizontal arrangements.
components-button: robust, structural button styles.
components-flex-embed: aspect-ratios for embeds.
components-grid: a grid foundation.
components-test: structure for visual tests.
theme: example theme.

You can also download pre-built bundles to try things out without setting up a build process:

base bundle
utils bundle
components bundle
everything bundle (only 4.4KB minified and gzipped)

Build and test tools

The suitcss-preprocessor runs CSS through a build pipeline. It performs per-file tests for conformance to the SUIT CSS naming conventions, and per-bundle tests for the IE selector limit. CSS build and test tools.

The preprocessor makes use of:

autoprefixer: automatic vendor prefixing
rework: a plugin framework for CSS preprocessing
rework-suit: a collection of "pure CSS" plugins for Rework
rework-suit-conformance: a SUIT CSS conformance tool

Complementary tools and libraries

Libraries / frameworks for component-based development:

Tools and dependency managers:

npm: package manager.
Component(1): front-end package manager and build tool.
component-builder-suit: per-file SUIT CSS tooling for Component(1).
html-inspector: test HTML templates for SUIT CSS conformance.

Development

Install Node (comes with npm).

npm install

To generate a build:

npm run build

Browser support

Chrome
Opera
Firefox
Safari 6+
Internet Explorer 9+

ecmartinez / suit