https://github.com/paulradzkov/space.less

Toolkit for managing negative space on frontend
https://github.com/paulradzkov/space.less

8px-grid css frontend less lesscss margin padding responsive spacing

Last synced: 3 days ago
JSON representation

Toolkit for managing negative space on frontend

• Host: GitHub
• URL: https://github.com/paulradzkov/space.less
• Owner: paulradzkov
• License: mit
• Created: 2016-10-09T18:28:20.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T09:24:30.000Z (over 4 years ago)
• Last Synced: 2024-05-23T07:01:44.585Z (4 months ago)
• Topics: 8px-grid, css, frontend, less, lesscss, margin, padding, responsive, spacing
• Language: CSS
• Homepage: http://paulradzkov.com/space.less/
• Size: 930 KB
• Stars: 6
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.json
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# space.less — toolkit for managing negative space

[![npm version](https://badge.fury.io/js/space.less.svg)](http://badge.fury.io/js/space.less)

[![bower version](https://badge.fury.io/bo/space.less.svg)](http://badge.fury.io/bo/space.less)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpaulradzkov%2Fspace.less.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpaulradzkov%2Fspace.less?ref=badge_shield)

Designed to make margins, paddings, gutters consistent across the project.

From design point of view this is an argeement on what distance to use between objects in UI layout.

From frontend perspective this is a set of classnames to rule margins and paddings on different media queries breakpoints.

Together it is a part of communication language between designers and frontend developers.

## Installation

**Compiled from CDN**  

[`https://unpkg.com/[email protected]/space.css`](https://unpkg.com/[email protected]/space.css)  

[`https://unpkg.com/[email protected]/space.min.css`](https://unpkg.com/[email protected]/space.min.css)  

[`https://unpkg.com/[email protected]/space.min.css.map`](https://unpkg.com/[email protected]/space.min.css.map)

**NPM**  

`npm install space.less --save-dev`

**Bower**  

`bower install space.less --save`

## Usage in HTML

Link compiled `space.css` in the head of your page.

Apply classes to any HTML element to get desired margins and paddings.

See [docs](http://paulradzkov.github.io/space.less/) for classnames.

## Usage in LESS

Install library with `npm install space.less --save-dev` and include its main file inside your project less file:

```less

@import (less) "./node_modules/space.less/space.less";

```

That is enough to run library with default parameters.

### Default parameters

Parameters stored in mixin:

```less

.space-settings() {

    @spaces: 0, 8px, 16px, 24px, 40px, 64px, 104px, 168px;

    @spacealias: zero, nano, micro, mili, base, kilo, mega, giga;

    // media breakpoints

    @breakpoints:

        ~"(min-width: 576px)",

        ~"(min-width: 768px)",

        ~"(min-width: 992px)",

        ~"(min-width: 1200px)";

    // names for breakpoint suffixes

    @suffixes: xs, sm, md, lg, xl;

    // IMPORTANT: suffixes count should be bigger than breakpoints count by 1

    // suffixes-count = breakpoints-count + 1

}

```

### Redefining parameters

To change any (or every) parameter add setting mixin after import inside your .less file:

```less

@import (less) "./node_modules/space.less/space.less";

.space-settings() {

    @spaces: 0, 5px, 10px, 25px, 50px;

    @spacealias: zero, small, normal, large, huge;

}

```

Only sizes and names for spacing was redefined in example above. Breakpoint parameters remains default.

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpaulradzkov%2Fspace.less.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpaulradzkov%2Fspace.less?ref=badge_large)