Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grvcoelho/css-styleguide

:book: Opinionated CSS styleguide for scalable applications
https://github.com/grvcoelho/css-styleguide

css naming-conventions styleguide

Last synced: 6 days ago
JSON representation

:book: Opinionated CSS styleguide for scalable applications

Awesome Lists containing this project

README 

        
# css



*Opinionated CSS styleguide for scalable applications*



This guide was heavily inspired by experiments, awesome people like [@fat](https://github.com/fat) and [@necolas](https://github.com/necolas) and awesome projects made by [Google](https://github.com/google), [Airbnb](https://github.com/airbnb) and [Medium](https://github.com/medium).



## Table of Contents



  1. [Terminology](#terminology)

    1. [Rule Declaration](#rule-declaration)

    1. [Selectors](#selectors)

    1. [Properties](#properties)

  1. [Formatting] (#formatting)

    1. [Spacing] (#spacing)

    1. [Nesting] (#nesting)

    1. [Quotes] (#quotes)

    1. [Comments] (#comments)

  1. [Syntax] (#syntax)

    1. [Components] (#components)

    1. [Descendants] (#descendants)

    1. [Modifiers] (#modifiers)

    1. [States] (#states)



## Terminology



The following are some terms used throughout this styleguide.



### Rule declaration



A “rule declaration” is the name given to a selector (or a group of selectors) with an accompanying group of properties. Here's an example:



```sass

.avatar {

  font-size: 18px;

  line-height: 1.2;

}

```



### Selectors



In a rule declaration, “selectors” are the bits that determine which elements in the DOM tree will be styled by the defined properties. Selectors can match HTML elements, as well as an element's class, ID, or any of its attributes. Here are some examples of selectors:



```sass

.avatar {

  font-size: 20px;

}



#id {

  font-size: 20px;

}

```



### Properties



Finally, properties are what give the selected elements of a rule declaration their style. Properties are key-value pairs, and a rule declaration can contain one or more property declarations. Property declarations look like this:



```sass

.avatar {

  background: rgb(255,255,255);

  color: rgb(33,33,33);

}

```



## Formatting



The following are some high level page formatting style rules.



### Spacing



CSS rules should be comma separated and leave on a new line:



```sass

/* wrong */

.avatar, .tweet {



}

```



```sass

/* right */

.avatar, 

.tweet {



}

```



Properties should use a space after `:` but not before:



```sass

/* wrong */

.avatar {

  font-size : 12px;

}



.tweet {

  font-size:12px;

}

```



```sass

/* right */

.avatar {

  font-size: 12px;

}

```



Rule declarations should have one property per line:



```sass

/* wrong */

.avatar {

  font-size: 12px; letter-spacing: 2px;

}

```



```sass

/* right */

.avatar {

  font-size: 12px; 

  letter-spacing: 2px;

}

```



Declaration should be separated by two new lines:



```sass

/* wrong */

.avatar {

  font-size: 12px;

}

.tweet {

  letter-spacing: 2px;

}

```



```sass

/* right */

.avatar {

  font-size: 12px;

}



.tweet {

  letter-spacing: 2px;

}

```



### Nesting



Do not nest elements. Keep nesting to pseudo-classes and direct interactions with the parent element. Although nesting is a powerful feature provided by several preprocessors and plugins, it can easily get out of control and generate a terrible css ouput with high specificity or spoil the code legibility.



```sass

/* wrong */

.avatar {

  font-size: 12px;

  

  &:hover {

    font-size: 11px;

  }

  

  &__link {

    color: rgb(210,210,22);

  }



  &__photo {

    height: 20px;

  }

}

```



```sass

/* right */

.avatar {

  font-size: 12px;

  

  &:hover {

    font-size: 11px;

  }

}



.avatar__link {

  color: rgb(210,22,221);

}



.avatar__photo {

  height: 20px;

}

```



Nesting can also be used to when an element is dependent of a parent's modifier. This helps to keep all code related to an element on the same block.



```sass

.avatar {

  font-size: 12px;

}



.avatar__photo {

  height: 20px;

  

  .avatar--big & {

    height: 40px;

  }

}

```



### Quotes



Quotes are optional in CSS. You should use single quotes as it is visually clearer that the string is not a selector or a style property.



```sass

/* wrong */

.avatar {

  background-image: url(/img/you.jpg);

  font-family: Helvetica Neue Light, Helvetica Neue, Helvetica, Arial;

}

```



```sass

/* right */

.avatar {

  background-image: url('/img/you.jpg');

  font-family: 'Helvetica Neue Light', 'Helvetica Neue', Helvetica, Arial;

}



```



### Comments



Avoid comments as hard as you can. Comments are not easily mantainable and are usually used to supress application design mistakes. Leave comments only to things that are **really** not straightforward such as browser-specific hacks. Put comments on their own lines to describe content below them.



```sass

/* wrong */

.avatar {

  height: 200px; /* this is the height of the container*/

  background-color: rgb(221,33,21); /* brand color */

}

```



```sass

/* right */

.avatar {

  height: 20px;

  

  /* this is a hack to fix click behavior on Safari 6.0 */

  pointer-events: none;

}

```



## Syntax



Syntax: `[--modifier-name|__descendant-name]`



Component driven development offers several benefits when reading and writing HTML and CSS:



* It helps to distinguish between the classes for the root of the component, descendant elements, and modifications.

* It keeps the specificity of selectors low.

* It helps to decouple presentation semantics from document semantics.



You can think of components as custom elements that enclose specific semantics, styling, and behaviour.



### Components 



Syntax: `component-name`



The component's name must be written in kebab case.



```sass

.my-component {

  font-size: 20px;

}

```



```html



```



### Descendants



Syntax: `component-name__descendant-name`



A component descendant is a class that is attached to a descendant node of a component. It's responsible for applying presentation directly to the descendant on behalf of a particular component. Descendant names must be written in kebab case.



```html



  

    {$alt}

    …

  

  


    …

  



```



### Modifiers



Syntax: `component-name--modifier-name`



A component modifier is a class that modifies the presentation of the base component in some form. Modifier names must be written in kebab case and be separated from the component name by two hyphens. The class should be included in the HTML _in addition_ to the base component class.



```sass

.btn {

  padding: 20px 10px;

}



.btn--primary { 

  background: rgb(148,146,231);

}

```



```html

…

```



### States



Syntax: `component-name.is-state-of-component`



Use `is-stateName` for state-based modifications of components. The state name must be kebab case. **Never style these classes directly; they should always be used as an adjoining class.**



JS can add/remove these classes. This means that the same state names can be used in multiple contexts, but every component must define its own styles for the state (as they are scoped to the component).



```sass

.tweet { 

  height: 90px;

}



.tweet.is-expanded { 

  height: 200px;

}

```



```html



```



## License



[MIT](https://github.com/grvcoelho/css/blob/master/LICENSE) © 2016