spaaace v1.0.2

Spaaace

Helper classes for CSS spacing based on Space in design systems.

I found this article quite helpful, even though I'm not a designer I still am a frontender and thus sometimes I do have to make decisions related to spacing and other visual elements. This set of guidelines come in handy when a quick padding or margin has to be put in place but instead of trying "random" numbers these sizes are now a sort of go to solution. This is also a project I used to dip my feet on Stylus, even if it really was just a tiny bit.

Getting Started

There's no real science for getting started with this project.

A note on the sizes used: The base unit of measure used was 2 pixels and then an exponential function applied until the desired maximum size. The article mentioned, however, that many other systems can be adopted to calculate these sizes.

Prerequisites

To compile a new version you'll need:

• Nodejs
• Npm
• Stylus

Note: As of NPM v5.2, a new tool to run scripts is included, npx, which let's developers run local binaries from the node_modules folder without having to write the full path to them. The build scripts take advantage of that and thus that's the minimum required version of npm to compile this project.

Installing

There is no development environment due to the size of the project but get everything needed to compile a new version the steps are:

Install nodejs (npm is included)

Linux

curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
sudo apt-get install -y nodejs

Next install the project dependencies

npm install

To test that everything is installed execute npm run compile and it should generate a new style.css file.

Deployment

To use this in a project just import the css file from node_modules/spaaace/style.css.

Usage

The classes are divided into 5 main types

• inset - For spacing inside an element.
• inset-stretch - Same as inset with less space on the right and left
• inset-squish - Same as inset with less space on top and bottom
• stack - For spacing outside the element's bottom

• inline - For spacing outside the element's right

  The following are the sizes to be used in conjunction to the previous types (ex: inset-xl)

• xxs (excluding inset-stretch and inset-squish)

• xs
• ss
• m
• l
• xl

Examples: For visual reference open the index.html file which has all the classes laid out in different elements.

Built With

• Stylus

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Telmo Alves - Initial work - blugt

License

This project is licensed under the MIT License - see the LICENSE.md file for details