Syntax
- Use tabs with four spaces—code does not need to be rendered the same in any environment and developers should feel free to choose what works best for them to read
- When grouping selectors, keep individual selectors to a single line.
- Include one space before the opening brace of declaration blocks for legibility.
- Place closing braces of declaration blocks on a new line.
- Include one space after
:
for each declaration. - Each declaration should appear on its own line for more accurate error reporting.
- End all declarations with a semi-colon. The last declaration's is optional, but your code is more error prone without it.
- Comma-separated property values should include a space after each comma (e.g.,
box-shadow
). - Include spaces after commas within
rgb()
,rgba()
,hsl()
,hsla()
, orrect()
values. - Prefix property values or color parameters with a leading zero (e.g.,
0.5
instead of.5
and-0.5px
instead of-.5px
). - Do not use hex values (prefer
rgb()
orhsl()
but if you must use hex values then lower case them, e.g.,#fff
. Lowercase letters are much easier to discern when scanning a document as they tend to have more unique shapes. - Prefer relative units for typography and most properties over fixed units, e.g.
rem
,em
. The one exception is forwidth
andheight
properties. - Quote attribute values in selectors, e.g.,
input[type="text"]
. They’re only optional in some cases, and it’s a good practice for consistency. - Avoid specifying units for zero values, e.g.,
margin: 0;
instead ofmargin: 0px;
.
Questions on the terms used here? See the syntax section of the Cascading Style Sheets article on Wikipedia.
Declaration order
Related property declarations should be grouped together following the order:
- Display
- Positioning
- Box model
- Typography
- Animation
Display properties come first because they determine whether or not a element shows up, thus negating anything coming after it.
Positioning comes next because it can remove an element from the normal flow of the document and override box model related styles.
The box model comes next as it dictates a component's dimensions and placement.
Everything else takes place inside the component or without impacting the previous sections, and thus they come last.
For a complete list of properties and their order, please see the property order for our Stylelint.
Don't use @import
Compared to <link>
s, @import
is slower, adds extra page requests, and can cause other unforeseen problems. Avoid them and instead opt for an alternate approach:
- Use multiple
<link>
elements - Compile your CSS with a preprocessor like Sass into a single file
- Concatenate your CSS files with features provided in NodeJS, Jekyll, or other environments
For more information, read this article by Steve Souders.
Media query placement
Place media queries as close to their relevant rule sets whenever possible. Don't bundle them all in a separate stylesheet or at the end of the document. Doing so only makes it easier for folks to miss them in the future. Here's a typical setup.
Prefixed properties
Do not use vendor-prefixed properties; use tools like autoprefixer
and browserlist to handle situations like this as it keeps code future proof.
Single declarations
In instances where a rule set includes only one declaration, consider removing line breaks for readability and faster editing. Any rule set with multiple declarations should be split to separate lines.
The key factor here is error detection—e.g., a CSS validator stating you have a syntax error on Line 183. With a single declaration, there's no missing it. With multiple declarations, separate lines is a must for your sanity.
Shorthand notation
Limit shorthand declaration usage to instances where you must explicitly set all available values. Frequently overused shorthand properties include:
padding
margin
font
background
border
border-radius
Usually we don't need to set all the values a shorthand property represents. For example, HTML headings only set top and bottom margin, so when necessary, only override those two values. A 0
value implies an override of either a browser default or previously specified value.
Excessive use of shorthand properties leads to sloppier code with unnecessary overrides and unintended side effects.
The Mozilla Developer Network has a great article on shorthand properties for those unfamiliar with notation and behavior.
Nesting in Sass
Avoid unnecessary nesting. Just because you can nest, doesn't mean you always should. Consider nesting only if you must scope styles to a parent and if there are multiple elements to be nested.
Additional reading:
Operators in Sass
For improved readability, wrap all math operations in parentheses with a single space between values, variables, and operators.
Comments
Code is written and maintained by people. Ensure your code is descriptive, well commented, and approachable by others. Great code comments convey context or purpose. Do not simply reiterate a component or class name.
Be sure to write in complete sentences for larger comments and succinct phrases for general notes.
Class names
- Keep classes lowercase and use dashes (not underscores nor camelCase). Dashes serve as natural breaks in related class (e.g.,
.btn
and.btn-danger
). - Avoid excessive and arbitrary shorthand notation.
.btn
is useful for button, but.s
doesn't mean anything. - Keep classes as short and succinct as possible.
- Use meaningful names; use structural or purposeful names over presentational.
- Prefix classes based on the closest parent or base class.
- Use
[data-*]
attribute and attribute selectors to denote behavior (as opposed to style), but keep these classes out of your CSS.
It's also useful to apply many of these same rules when creating Sass variable names.
Selectors
- Use classes over generic element tag for optimum rendering performance.
- Avoid using several attribute selectors (e.g.,
[class^="..."]
) on commonly occuring components. Browser performance is known to be impacted by these. - Keep selectors short and strive to limit the number of elements in each selector to three.
- Scope classes to the closest parent only when necessary (e.g., when not using prefixed classes).
Additional reading:
Organization
- Organize sections of code by component.
- Develop a consistent commenting hierarchy.
- Use consistent white space to your advantage when separating sections of code for scanning larger documents.
- When using multiple CSS files, break them down by component instead of page. Pages can be rearranged and components moved.
Tip: Use spiderpig when attempting to change some existing CSS as it allows you to search through a site or application to see which pages are affected.