Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These standards should be followed for how visual designers will code banners and landing pages.

HTML

...

These will probably carry over to UI Code standards as well in the near future.

Table of Contents
maxLevel3
indent10px
stylenone

CSS/SCSS

Terminology

Rule Declaration

...

  1. Property declarations

    List all standard property declarations in alphabetical order, anything that isn't an @include or a nested selector.

    Code Block
    languagesass
    themeRDark
    firstline1
    linenumberstrue
    .btn-green {
      background: green;
      font-weight: bold;
      // ...
    }

  2. @include declarations

    Grouping @includes at the end makes it easier to read the entire selector.


    Code Block
    languagesass
    themeRDark
    firstline1
    linenumberstrue
    .btn-green {
      background: green;
      font-weight: bold;
      @include transition(background 0.5s ease);
      // ...
    }


  3. Nested selectors

    Nested selectors, if necessary, go last, and nothing goes after them. Add whitespace between your rule declarations and nested selectors, as well as between adjacent nested selectors. Apply the same guidelines as above to your nested selectors.



    Code Block
    languagesass
    themeRDark
    firstline1
    linenumberstrue
    .btn {
      background: green;
      font-weight: bold;
      @include transition(background 0.5s ease);
    
      .icon {
        margin-right: 10px;
      }
    }


...

Prefer dash-cased variable names (e.g. $my-variable) over camelCased or snake_cased variable names. It is acceptable to prefix variable names that are intended to be used only within the same file with an underscore (e.g. $_my-variable).

Mixins

Mixins should be used to DRY up your code, add clarity, or abstract complexity--in much the same way as well-named functions. Mixins that accept no arguments can be useful for this, but note that if you are not compressing your payload (e.g. gzip), this may contribute to unnecessary code duplication in the resulting styles.

Extend directive

@extend should be avoided because it has unintuitive and potentially dangerous behavior, especially when used with nested selectors. Even extending top-level placeholder selectors can cause problems if the order of selectors ends up changing later (e.g. if they are in other files and the order the files are loaded shifts). Gzipping should handle most of the savings you would have gained by using @extend, and you can DRY up your stylesheets nicely with mixins.

Nested selectors

Do not nest selectors more than three levels deep!

Code Block
languagecss
themeRDark
firstline1
linenumberstrue
.page-container {
  .content {
    .profile {
      // STOP!
    }
  }
}

When selectors become this long, you're likely writing CSS that is:

...

If you must use an ID selector in the first place (and you should really try not to), they should never be nested. If you find yourself doing this, you need to revisit your markup, or figure out why such strong specificity is needed. If you are writing well formed HTML and CSS, you should never need to do this.

JS

TBD

Reference

https://sass-lang.com/guide

airbnb coding standards