INNOQ Living Styleguide

Welcome

This is the official INNOQ style guide. In here, we develop and document all frontend components of our current corporate design. You can see them in use at innoq.com.

Methodologies

When developing our components we try to adhere to Atomic Design. As a consequence, components are organized into

  • 01-atoms
  • 02-molecules
  • 03-organisms
  • 04-pages

For structuring our CSS folders and files, we use ITCSS.

We also use BEM syntax for naming of our CSS classes.

Technology

We deeply believe in the web, so all of our components are developed according to the ROCA principles and Progressive Enhancement. There aren’t any React components or Angular monstrosities in here just for the sake of it.

Installation

Using npm:

  npm install innoq-styleguide --save(-dev)

Using yarn:

  yarn add innoq-styleguide (--dev)

Usage

Sass components

You can import the whole slaw of components:

    @import "innoq-styleguide/dist/sass/index";

…or just the stuff you need:

    @import "innoq-styleguide/dist/components/01-atoms/form/button/button";

JavaScript components

Some of our frontend components are enhanced with JavaScript. They are written in ESNext and are based on JavaScript Custom Elements Please note that we don’t bundle any polyfill for customElements in our npm releases, use document-register-element if needed.

After installation, you can import and register them:

   import InfoBox from 'innoq-styleguide/dist/js/components/info-box'
   customElements.define('info-box', InfoBox)

Bootstrap Theme

There’s a branded Bootstrap 4 theme available here.

Development

The source repository can be found on GitHub.