Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NebulaUI/nebula-css
💫 ITCSS and BEM based Sass/CSS toolkit; extensible & scalable to any project size
https://github.com/NebulaUI/nebula-css
architecture bem-methodology css itcss sass-framework sass-map ui-grid
Last synced: 3 months ago
JSON representation
💫 ITCSS and BEM based Sass/CSS toolkit; extensible & scalable to any project size
- Host: GitHub
- URL: https://github.com/NebulaUI/nebula-css
- Owner: NebulaUI
- License: mit
- Created: 2015-10-28T22:48:45.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-03-19T11:10:59.000Z (almost 6 years ago)
- Last Synced: 2024-09-26T01:35:42.915Z (3 months ago)
- Topics: architecture, bem-methodology, css, itcss, sass-framework, sass-map, ui-grid
- Language: CSS
- Homepage: https://nebulaui.github.io/nebula/
- Size: 377 KB
- Stars: 62
- Watchers: 4
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nebula CSS  [](https://badge.fury.io/js/nebula-css)
* 6kb (gzip) with default settings.
* [View the demo](http://rbrtsmith.com/nebula)
* `yarn add nebula-css` / [Get started](#get-started)
* Check out [Nebula-CSS React Starter](https://github.com/rbrtsmith/nebula-css-react-starter) to see how this can be integrated into a ReactJS project.
Super low-level mobile-first Sass framework using the [ITCSS](https://www.youtube.com/watch?v=1OKZOV-iLj4) architecture and the [BEM(IT)](http://csswizardry.com/2015/08/bemit-taking-the-bem-naming-convention-a-step-further/) naming convention.
Rather than using 'semantic classnames' that some other frameworks push, the classnames employed in Nebula explicitly describe the underlying architecture.
This makes it *much* easier to reason about the CSS structure from your HTML, promotes code re-use and composition; which otherwise would all be severely hindered if classnames were closely coupled with content.
Ships with zero cosmetic styling; this allows every consuming project to have a completely bespoke UI with Nebula CSS doing the heavy lifting when it comes to layout and architecture. This means it is totally upto you how you structure your colours, typography and cosmetic components, however you are encouraged to follow the ITCSS structure and BEMIT naming conventions.
At the core sits a highly flexible and and extendible grid system making use of the very powerful [map](https://www.viget.com/articles/sass-maps-are-awesome) feature of Sass.
Maps are used extensively and allow the following features to be easily extended and in some cases composed:
* Breakpoints
* Grid fractions
* Grid offsets
* Grid guttering
* List spacing
* Section spacing
* Spacing - margin & padding utilities
Nebula CSS also ships with some common yet useful abstractions such as the Flag Object, list variations and an array of useful utilities.
## Table of contents
* [Intro to ITCSS](#intro-to-itcss)
* [Dependencies](#dependencies)
* [Get started](#get-started)
* [Default settings and config](#default-settings-and-config)
* [Overriding settings](#overriding-settings)
* [Breakpoints](#breakpoints)
* [Grid](#grid)
* [Flag](#flag)
* [Site-wrap](#site-wrap)
* [Section](#section)
* [Lists](#lists)
* [Bare list](#bare-list)
* [Inline list](#inline-list)
* [Matrix list](#matrix-list)
* [Uniformed list](#uniformed-list)
* [Utilities](#utilities)
* [Push](#push)
* [Flush](#flush)
* [Soft](#soft)
* [Hard](#hard)
* [Hidden](#hidden)
## Intro to ITCSS
Nebula CSS is built upon the [ITCSS](https://www.youtube.com/watch?v=1OKZOV-iLj4) architecture popularised by [Harry
Roberts](http://csswizardry.com/).
ITCSS stands for *Inverted Triangle* architecture for *CSS*
It is a sane, scalable, managed architecture and is more of a school of thought than a framework.
The architecture is based on the *write CSS in specificity order* principle; this eliminates many of the specificity issues that occur as a project scales.
ITCSS is divided up into 7 distinct sections they are:
1. Settings
2. Tools
3. Resets
4. Base
5. Objects
6. Components
7. Utilities
### 1. Settings
Global variables and config.
### 2. Tools
Globally used mixins and functions.
### 3. Resets (Generic)
[Normalize.css](https://github.com/necolas/normalize.css/) and any additional
resets on top of Normalize.
### 4. Base
Global baseline styles using element and attribute selectors only (No classes)
### 5. Objects
Cosmetic-free design patters, things like the grid, lists and the flag
object. Think of it like the skeleton of the layout, with no visual styling
applied.
### 6. Components
Designed components, chunks of UI. Think of it like the skin on top of the
skeleton, so anything with colours, borders, backgrounds etc. If in doubt
whether some CSS/Sass code belongs in layout or components then put it within
components. **Being cosmetic free Nebula CSS does not ship with any components**
### 7. Utilities
Helpers and overrides. AKA Trumps.
## Dependencies
Nebula CSS is composed of [Sass](http://sass-lang.com/) files so you'll need some way to compile to CSS; we'd recommend you use a [Libsass](http://sass-lang.com/libsass) based tool, which will likely be available for your build tool of choice:
* [Node Sass](https://github.com/sass/node-sass) (NPM Scripts)
* [Webpack Sass Loader](https://github.com/jtangelder/sass-loader) (Webpack)
* [Gulp Sass](https://github.com/dlmanning/gulp-sass) (Gulp)
Having a deep knowledge of Sass is not required to consume Nebula CSS, but a familiarity will greatly help you get the most out of this architecture.
**This document assumes you have [NodeJS](https://nodejs.org/en/) installed on your machine.**
Nebula's source code does not include any vendor prefixes. This gives you the freedom to configure [Autoprefixer](https://github.com/postcss/autoprefixer) to the browsers that you intend to support.
This can be ran directly in NPM scripts as you can see happening in this projects [package.json](https://github.com/rbrtsmith/nebula-css/blob/master/package.json#L9). Alternatively you can run this in your build-tool of choice.
## Get Started
1. `yarn add nebula-css` OR `npm i -S nebula-css`
2. Setup an ITCSS file structure:
1. `cd` into the directory where you intend to build out your ITCSS structure.
2. Paste the following snippet into your terminal:
- Mac / Linux users
```
mkdir scss &&
cd scss &&
{
echo "@import 'settings';"
echo "@import 'tools';"
echo "@import 'resets';"
echo "@import 'base';"
echo "@import 'objects';"
echo "@import 'components';"
echo "@import 'utilities';"
echo ""
} > main.scss &&
echo "@import 'nebula-css/settings';" > _settings.scss &&
echo "@import 'nebula-css/tools';" > _tools.scss &&
echo "@import 'nebula-css/resets';" > _resets.scss &&
echo "@import 'nebula-css/base';" > _base.scss &&
echo "@import 'nebula-css/objects';" > _objects.scss &&
echo "@import 'nebula-css/utilities';" > _utilities.scss &&
touch _components.scss &&
cd ..
```
- Windows users
```
mkdir scss
cd scss
echo @import 'settings'; >> main.scss
echo @import 'tools'; >> main.scss
echo @import 'resets'; >> main.scss
echo @import 'base'; >> main.scss
echo @import 'objects'; >> main.scss
echo @import 'components'; >> main.scss
echo @import 'utilities'; >> main.scss
echo @import 'nebula-css/settings'; > _settings.scss
echo @import 'nebula-css/tools'; > _tools.scss
echo @import 'nebula-css/resets'; > _resets.scss
echo @import 'nebula-css/base'; > _base.scss
echo @import 'nebula-css/objects'; > _objects.scss
echo @import 'nebula-css/utilities'; > _utilities.scss
echo.> _components.scss
cd ..
```
The following file structure will be created.
```
scss/
|
├──main.scss
├──_settings.scss
├──_tools.scss
├──_resets.scss
├──_base.scss
├──_objects.scss
├──_components.scss
├──_utilities.scss
```
`main.scss` gets populated with the seven ITCSS layers.
```sass
/* main.scss */
@import 'settings';
@import 'tools';
@import 'resets';
@import 'base';
@import 'objects';
@import 'components';
@import 'utilities';
```
The files that `main.scss` imports are also populated with `@import` statements
that are pulling in the corresponding ITCSS layer from Nebula CSS. E.g.
```sass
/* _settings.scss */
@import 'nebula-css/settings';
```
It is worth noting here that to resolve the above path your Sass compiler requires
[Node-sass IncludePaths](https://github.com/sass/node-sass#includepaths)
If your Sass Compiler does not offer IncludePaths resulting in your build failing
you will have to give your imports a relative path:
```sass
/* _settings.scss */
@import '[path-to-node-modules]/nebula-css/nebula-css/settings';
```
As you can see this is rather verbose and ugly code but it works!
Below is an example of an NPM script configured to compile Sass and making use of `includePaths` pointing to the directory to be resolved `./node-modules/nebula-css/`
```json
"scripts": {
"sass": "node-sass --include-path ./node_modules/nebula-css/ -o dist src/scss/main.scss",
},
```
See how the NPM scripts [package.json](https://github.com/rbrtsmith/nebula-css/blob/master/package.json#L8) are configured for the Nebula CSS Demo.
Alternatively here's an example using Gulp.
```javascript
gulp.task('build:css', () => {
const includePaths = ['./node_modules/nebula-css/'];
return gulp.src('src/scss/**/*.scss')
.pipe(sass({ includePaths }))
.pipe(gulp.dest('dist'))
});
```
3. Configure your build tool to build your Sass files and run Autoprefixer
4. You can now start extending Nebula with your own styling. Following with the ITCSS structure it's recommended that you create the folders for the layers that you are extending and `@import` those files.
An example structure might look like this:
```
scss/
|
├──main.scss
├──_settings.scss
├──_tools.scss
├──_resets.scss
├──_base.scss
├──_objects.scss
├──_components.scss
├──_utilities.scss
├──settings/
| └──_nebula-overrides.scss
| └──_my-settings.scss
├──base/
| └──_my-base-styles.scss
├──objects
| ├──_my-object-1.scss
| └──_my-object-2.scss
├──components/
| ├──_my-component-1.scss
| └──_my-component-2.scss
└──utilities/
├──_my-utility-1.scss
└──_my-utility-2.scss
```
## Default settings and config
Some of the settings here make use of [Sass maps](https://www.viget.com/articles/sass-maps-are-awesome) it's recommended you have at least a basic understanding of how they work.
Defines the namespace to be added to classes generated by Nebula.
```sass
$nb-namespace: '' !default;
```
Defines the maximum width of the site wrapper `o-site-wrap`
```sass
$nb-site-wrap-width: 60rem !default;
```
The spacing unit is used throughout the entire framework for spacing and guttering. It yields consistent spacing rhythm throughout your project.
```sass
$nb-spacing-unit: 1rem !default;
```
Base font-sizing for body copy.
```sass
$nb-base-font-size: 1rem !default;
```
The delimiter to use for responsive variations of classes. Default `@`. (Can be changed to i.e. `-bp-` to allow CSS modules' `composes:` as that doesn't work with `@` in class names)
```sass
$nb-breakpoint-class: '\\@' !default;
```
Breakpoints using a Sass Map. the keys `sm`, `md` are used to generate the responsive classnames. Being a Sass map it is possible to add or remove breakpoints and of course you can change the values.
```sass
$nb-breakpoints: (
sm: 720px,
md: 960px,
lg: 1200px
) !default;
```
The root font-sizing set as a percentage on the `` element.
The key `default` being the initial sizing up until the key matching the `$nb-breakpoints` key. In this case `sm` So screens larger than 720px will get 100% root-font sizing. Those smaller will receive 90%.
```sass
$nb-root-sizing: (
default: 90%,
sm: 100%
) !default;
```
List Spacing for all kinds of lists such as `inline-list`, `bare-list` `matrix-list`. The keys here are used to generate the BEM modifier classnames
so you can name then whatever you deem appropriate. By default you are provided with a single `md` key.
```sass
$nb-list-spacing: (
md: $nb-spacing-unit
) !default;
```
Spacing for all sections. The Sass map here operates exactly like `$nb-list-spacing`. above.
```sass
$nb-section-spacing: (
md: ($nb-spacing-unit * 2)
) !default;
```
The grid system uses inline-blocks. To remove the whitespace between grid-items it's required that a font-size of zero is set on the wrapping element, then the child elements are reset using `$nb-base-font-size`. If you are minifying your HTML or using JSX with a framework like React it is safe to turn this off.
```sass
$nb-use-grid-zero-font-size: true !default;
```
Gutter sizes for the grid system. By default we have three sizes, you can add or remove these to suit your projects needs.
```sass
$nb-grid-gutter-sizes: (
sm: ($nb-spacing-unit / 2),
md: $nb-spacing-unit,
lg: ($nb-spacing-unit * 2)
) !default;
```
Offsets used for the grid based in fractions whereby `1/2` will yield a width of `50%`. This Sass map is also used for Push/Pull offsets on the grid. Being a Sass map you are free to add or remove whatever offsets are suitable for your project needs. Note that the keys are quoted due to a fraction being used. You can also turn off width/push/pull offsets globally saving you from bloat if any of those features are not being used.
```sass
$nb-use-width-offsets: true !default;
$nb-use-push-offsets: true !default;
$nb-use-pull-offsets: true !default;
$nb-offset-fractions: (
'1/1': 1/1,
'1/2': 1/2,
'1/3': 1/3,
'2/3': 2/3,
'1/4': 1/4,
'2/4': 2/4,
'3/4': 3/4,
'1/5': 1/5,
'2/5': 2/5,
'3/5': 3/5,
'4/5': 4/5,
'1/6': 1/6,
'2/6': 2/6,
'3/6': 3/6,
'4/6': 4/6,
'5/6': 5/6,
'1/8': 1/8,
'2/8': 2/8,
'3/8': 3/8,
'4/8': 4/8,
'5/8': 5/8,
'6/8': 6/8,
'7/8': 7/8,
'1/10': 1/10,
'2/10': 2/10,
'3/10': 3/10,
'4/10': 4/10,
'5/10': 5/10,
'6/10': 6/10,
'7/10': 7/10,
'8/10': 8/10,
'9/10': 9/10,
'1/12': 1/12,
'2/12': 2/12,
'3/12': 3/12,
'4/12': 4/12,
'5/12': 5/12,
'6/12': 6/12,
'7/12': 7/12,
'8/12': 8/12,
'9/12': 9/12,
'10/12': 10/12,
'11/12': 11/12
) !default;
```
Used for the `Push` utility to add margin to a component.
```sass
$nb-push-sizes: (
md: $nb-spacing-unit
) !default;
```
Used for the `Soft` utility to add padding to a component.
```sass
$nb-soft-sizes: (
md: $nb-spacing-unit
) !default;
```
### Overriding settings
When you install this framework it will live in your `node_modules` directory and you won't want to go in there and change anything as any subsequent `npm install`s will potentially overwrite those changes.
Thankfully Nebula CSS settings all have the `!default` flag attached which means they can be overridden:
```sass
/*_settings.scss*/
@import 'nebula-css/settings';
@import 'settings/my-overrides';
```
```sass
/*/settings/_my-overrides.scss*/
$nb-breakpoints: (
sm: 800px,
md: 900px,
lg: 1000px,
xl: 1100px
);
```
The above code will override the default `$nb-breakpoints` map with your own.
## Breakpoints
The breakpoints map shown above (`$nb-breakpoints`) contains all of the breakpoints used in Nebula, you can add remove and edit the breakpoints in the map. Nebula CSS features such as the lists, section, grid gutters, grid widths, push, flush, hard and soft utilities are all auto generate the CSS based on `$nb-breakpoints`. The keys used in the map correlate directly to classnames generated. For example:
```sass
$nb-breakpoints: (
sm: 400px,
md: 800px,
myKey: 1000px
);
```
and assuming we had the following declared:
```sass
$nb-list-spacing: (
md: $nb-spacing-unit
) !default;
```
Will generate the following CSS classnames in our Bare list (Amongst the other objects)
```Sass
.o-bare-list {}
.o-bare-list--spaced-md {}
.o-bare-list--spaced-md\@sm {}
.o-bare-list--spaced-md\@md {}
.o-bare-list--spaced-md\@myKey {}
```
If our List spacing increased to:
```sass
$nb-list-spacing: (
md: $nb-spacing-unit,
lg: ($nb-spacing-unit * 2)
) !default;
```
The following CSS classnames would be generated:
```sass
.o-bare-list {}
.o-bare-list--spaced-md {}
.o-bare-list--spaced-md\@sm {}
.o-bare-list--spaced-md\@md {}
.o-bare-list--spaced-md\@myKey {}
.o-bare-list--spaced-lg {}
.o-bare-list--spaced-lg\@sm {}
.o-bare-list--spaced-lg\@md {}
.o-bare-list--spaced-lg\@myKey {}
```
As we can see in these examples the `@` symbol denotes that this class applies to a particular breakpoint, the chars after should map directly to a key in `$nb-breakpoints`.
Also note that the `@` symbol here is escaped, this is because symbols like `@` are not strictly valid CSS selectors so they must be escaped. However you don't need to do this when defining your classnames in your HTML.
Nebula CSS also provides you with a mixin that can be use to interface with the defined breakpoints: `nb-respond-to()` This mixin accepts a string argument. The string should match one of the maps in `nb-breakpoints`. e.g.
```sass
.o-my-obj {
@include nb-respond-to('md') {
// my CSS
}
}
```
Being mobile first the above CSS will respond to viewports larger than the `md` breakpoint (min-width media query). It is possible to pass in a prefix as part of the sring to denote a max-width breakpoint:
```sass
.o-my-obj {
@include nb-respond-to('max-md') {
// my CSS
}
}
```
The above CSS responding to viewports smaller than the `md` breakpoint.
`nb-respond-to` also accepts an optional second argument if you wish to create a second breakpoints map that you don't wish the grid, and other utilities to map over - something more component specific. By default this parameter points to `$nb-breakpoints`.
## Grid
[Demo](https://nebulaui.github.io/nebula/api/objects/grid)
The grid system employed in Nebula CSS uses fractions rather than columns yielding increased flexibility. Instead of many other popular grid systems Nebula CSS uses inline-block as opposed to floats; this results in many benefits.
### Features
* Fluid
* Infinitely nestable
* Equal height grid items based on Flexbox (IE10+)
* Vertical alignment of grid items
* Vertical gutters
* Variable gutter sizing
* horizontal reversal of grid-items
* No clearfixing required, rows of items with uneven heights tile gracefully.
* Classnames based on BEMIT fractions and responsive suffixes
* Does not require a wrapping element like most other grid systems.
* Extremely lightweight using the Sass maps found in [Default settings and config](#default-settings-and-config) unused bloat can be removed.
* Width, push and pull classes are not tied directly to the grid, and can be reused anywhere in your project.
By default the grid comes with the following sets of fractions:
* One whole
* Halves
* Thirds
* Fourths
* Fifths
* Sixths
* Eighths
* Tenths
* Twelfths
As defined in the `$nb-offset-fractions` map. You can add or remove fractions on the map to suit your project requirements. The fractions map directly to the breakpoints.
By default Nebula CSS provides three gutter width variations from the `nb-grid-gutter-sizes` map, again these can be removed, adjusted or added to.
With a seemingly endless number of combinations available this makes Nebula CSS's grid one of the most flexible available.
### Examples
A simple grid with two grid-items one 25% wide the other 75%. By default the grid comes with no gutters.
```html
25% wide
75% wide
```
Responsive breakpoints
```html
25% wide at screens larger than the `sm` breakpoint.
75% wide at screens larger than the `sm` breakpoint.
```
Medium sized guttering
```html
25% wide at screens larger than the `sm` breakpoint.
75% wide at screens larger than the `sm` breakpoint.
```
Varying guttering depending on the breakpoint
```html
25% wide
75% wide
```
There are various BEM modifiers that you can add to the grid as shown below:
* Matrix (Vertical guttering that matches horizontal)
```html
```
* Equal height items
```html
```
* Reverse item order
```html
```
* Vertically centered items
```html
```
* Bottom aligned items
```html
```
* Horizontally centered items
```html
```
## Flag
One of most underrated CSS abstractions originally thought up by [Harry Roberts](https://twitter.com/csswizardry) is the flag object. It allows you to mix up fixed width components with fluid ones, is infinitely composable can be nested inside of the grid, or a grid nested inside of the fluid component it's incredibly versatile. Oh and it also allows you to vertically align the contents to boot.
[Demo](https://nebulaui.github.io/nebula/api/objects/flag)
```html
Checkout my amazing dog!
```
## Site-wrap
A simple max-width centred container to wrap your content. You can see it applied throughout the demo page. The `--padding` modifier adds horizontal padding to the container.
[demo](https://nebulaui.github.io/nebula/api/objects/site-wrap)
```html
Main content.
```
## Section
Adds padding top & bottom. The `md` suffix in this example maps onto a corresponding key on the `$nb-section-spacing` map that denotes the spacing amount.
[demo](https://nebulaui.github.io/nebula/api/objects/section)
Typically used to space sections and sub-sections of content.
```html
Main content.
```
## Lists
Nebula CSS comes with three types of list: Bare-list, Inline-list and Matrix-list.
[demo](https://nebulaui.github.io/nebula/api/objects/lists)
### Bare-list
Strips a list of all default list styling.
```html
```
Spaced
```html
```
Spaced by breakpoint
```html
```
## Inline list
Exactly like the bare list but the items are rendered horizontally.
```html
- item
- item
```
```html
- item
- item
```
Spaced by breakpoint
```html
- item
- item
```
## Matrix list
Exactly like the inline list but the items vertical spacing matches the horizontal.
Spaced
```html
- item
- item
```
Spaced by breakpoint
```html
- item
- item
```
## Uniformed list
Throws the list items into a horizontal alignment, each having a uniformed width.
```html
- item
- item
```
Uniformed by breakpoint.
```html
- item
- item
```
## Utilities
Form the Utilities Layer in ITCSS, each a single responsibility class. They are intended to be used as overrides.
[Demo]((https://nebulaui.github.io/nebula/api/utility-classes))
### Push
Adds margins.
Nebula CSS encourages [single direction margin declarations](http://csswizardry.com/2012/06/single-direction-margin-declarations/) to eliminate confusion around collapsing borders
```html
```
### Flush
Removes margins
```html
```
### Soft
Adds padding
```html
```
### Hard
Removes padding
```html
```
### Text-align
Adds text-alignment.
```html
```
### Hidden
Hides elements, or visually hides (Still accessible.)
```html
```