diff --git a/.scss-lint.yml b/.scss-lint.yml index ddaf372..d90fa16 100644 --- a/.scss-lint.yml +++ b/.scss-lint.yml @@ -1,8 +1,10 @@ +severity: error + linters: BorderZero: enabled: true - convention: none + convention: zero BemDepth: enabled: true @@ -10,9 +12,19 @@ linters: DeclarationOrder: enabled: false + ExtendDirective: + enabled: true + LeadingZero: enabled: false + NameFormat: + enabled: true + + PrivateNamingConvention: + enabled: true + prefix: _ + PropertySortOrder: enabled: false diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..29ac7c8 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2015 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 94cf8d1..17a88a1 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,33 @@ +| :exclamation: Deprecation Notice | +|:-| +|We want to express our sincere gratitude for your support and contributions to this open source project. As we are no longer using this technology internally, we have come to the decision to archive this repository. While we won't be providing further updates or support, the existing code and resources will remain accessible for your reference. We encourage anyone interested to fork the repository and continue the project's legacy independently. Thank you for being a part of this journey and for your patience and understanding.| + # Airbnb CSS / Sass Styleguide *A mostly reasonable approach to CSS and Sass* ## Table of Contents - 1. [Terminology](#terminology) +1. [Terminology](#terminology) - [Rule Declaration](#rule-declaration) - [Selectors](#selectors) - [Properties](#properties) - 1. [CSS](#css) +1. [CSS](#css) - [Formatting](#formatting) - [Comments](#comments) - [OOCSS and BEM](#oocss-and-bem) - [ID Selectors](#id-selectors) - [JavaScript hooks](#javascript-hooks) - 1. [Sass](#sass) + - [Border](#border) +1. [Sass](#sass) - [Syntax](#syntax) - [Ordering](#ordering-of-property-declarations) + - [Variables](#variables) - [Mixins](#mixins) - - [Placeholders](#placeholders) + - [Extend directive](#extend-directive) - [Nested selectors](#nested-selectors) +1. [Translation](#translation) +1. [License](#license) ## Terminology @@ -59,18 +67,21 @@ Finally, properties are what give the selected elements of a rule declaration th } ``` +**[⬆ back to top](#table-of-contents)** + ## CSS ### Formatting -* Use soft tabs (2 spaces) for indentation -* Prefer dashes over camelCasing in class names. Underscores are OK if you're using BEM (see [OOCSS and BEM](#oocss-and-bem) below). -* Do not use ID selectors +* Use soft tabs (2 spaces) for indentation. +* Prefer dashes over camelCasing in class names. + - Underscores and PascalCasing are okay if you are using BEM (see [OOCSS and BEM](#oocss-and-bem) below). +* Do not use ID selectors. * When using multiple selectors in a rule declaration, give each selector its own line. -* Put a space before the opening brace `{` in rule declarations +* Put a space before the opening brace `{` in rule declarations. * In properties, put a space after, but not before, the `:` character. -* Put closing braces `}` of rule declarations on a new line -* Put blank lines between rule declarations +* Put closing braces `}` of rule declarations on a new line. +* Put blank lines between rule declarations. **Bad** @@ -118,7 +129,7 @@ We encourage some combination of OOCSS and BEM for these reasons: * It allows for less nesting and lower specificity * It helps in building scalable stylesheets -**OOCSS**, or “Object Oriented CSS”, is an approach for writing CSS that encourages you to think about your stylesheets as a collection of “objects”: reusuable, repeatable snippets that can be used independently throughout a website. +**OOCSS**, or “Object Oriented CSS”, is an approach for writing CSS that encourages you to think about your stylesheets as a collection of “objects”: reusable, repeatable snippets that can be used independently throughout a website. * Nicole Sullivan's [OOCSS wiki](https://github.com/stubbornella/oocss/wiki) * Smashing Magazine's [Introduction to OOCSS](http://www.smashingmagazine.com/2011/12/12/an-introduction-to-object-oriented-css-oocss/) @@ -128,30 +139,38 @@ We encourage some combination of OOCSS and BEM for these reasons: * CSS Trick's [BEM 101](https://css-tricks.com/bem-101/) * Harry Roberts' [introduction to BEM](http://csswizardry.com/2013/01/mindbemding-getting-your-head-round-bem-syntax/) +We recommend a variant of BEM with PascalCased “blocks”, which works particularly well when combined with components (e.g. React). Underscores and dashes are still used for modifiers and children. + **Example** -```html - + ); +} ``` ```css -.listing-card { } -.listing-card--featured { } -.listing-card__title { } -.listing-card__content { } +/* ListingCard.css */ +.ListingCard { } +.ListingCard--featured { } +.ListingCard__title { } +.ListingCard__content { } ``` - * `.listing-card` is the “block” and represents the higher-level component - * `.listing-card__title` is an “element” and represents a descendant of `.listing-card` that helps compose the block as a whole. - * `.listing-card--featured` is a “modifier” and represents a different state or variation on the `.listing-card` block. + * `.ListingCard` is the “block” and represents the higher-level component + * `.ListingCard__title` is an “element” and represents a descendant of `.ListingCard` that helps compose the block as a whole. + * `.ListingCard--featured` is a “modifier” and represents a different state or variation on the `.ListingCard` block. ### ID selectors @@ -169,46 +188,54 @@ We recommend creating JavaScript-specific classes to bind to, prefixed with `.js ``` +### Border + +Use `0` instead of `none` to specify that a style has no border. + +**Bad** + +```css +.foo { + border: none; +} +``` + +**Good** + +```css +.foo { + border: 0; +} +``` +**[⬆ back to top](#table-of-contents)** + ## Sass ### Syntax * Use the `.scss` syntax, never the original `.sass` syntax -* Order your `@extend`, regular CSS and `@include` declarations logically (see below) +* Order your regular CSS and `@include` declarations logically (see below) ### Ordering of property declarations -1. `@extend` declarations - - Just as in other OOP languages, it's helpful to know right away that this “class” inherits from another. - - ```scss - .btn-green { - @extend %btn; - // ... - } - ``` - -2. Property declarations +1. Property declarations - Now list all standard property declarations, anything that isn't an `@extend`, `@include`, or a nested selector. + List all standard property declarations, anything that isn't an `@include` or a nested selector. ```scss .btn-green { - @extend %btn; background: green; font-weight: bold; // ... } ``` -3. `@include` declarations +2. `@include` declarations - Grouping `@include`s at the end makes it easier to read the entire selector, and it also visually separates them from `@extend`s. + Grouping `@include`s at the end makes it easier to read the entire selector. ```scss .btn-green { - @extend %btn; background: green; font-weight: bold; @include transition(background 0.5s ease); @@ -216,13 +243,12 @@ We recommend creating JavaScript-specific classes to bind to, prefixed with `.js } ``` -4. Nested selectors +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. ```scss .btn { - @extend %btn; background: green; font-weight: bold; @include transition(background 0.5s ease); @@ -233,51 +259,17 @@ We recommend creating JavaScript-specific classes to bind to, prefixed with `.js } ``` -### Mixins - -Mixins, defined via `@mixin` and called with `@include`, should be used sparingly and only when function arguments are necessary. A mixin without function arguments (i.e. `@mixin hide { display: none; }`) is better accomplished using a placeholder selector (see below) in order to prevent code duplication. +### Variables -### Placeholders +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`). -Placeholders in Sass, defined via `%selector` and used with `@extend`, are a way of defining rule declarations that aren't automatically output in your compiled stylesheet. Instead, other selectors “inherit” from the placeholder, and the relevant selectors are copied to the point in the stylesheet where the placeholder is defined. This is best illustrated with the example below. - -Placeholders are powerful but easy to abuse, especially when combined with nested selectors. **As a rule of thumb, avoid creating placeholders with nested rule declarations, or calling `@extend` inside nested selectors.** Placeholders are great for simple inheritance, but can easily result in the accidental creation of additional selectors without paying close attention to how and where they are used. - -**Sass** - -```sass -// Unless we call `@extend %icon` these properties won't be compiled! -%icon { - font-family: "Airglyphs"; -} - -.icon-error { - @extend %icon; - color: red; -} - -.icon-success { - @extend %icon; - color: green; -} -``` +### Mixins -**CSS** +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. -```css -.icon-error, -.icon-success { - font-family: "Airglyphs"; -} - -.icon-error { - color: red; -} +### Extend directive -.icon-success { - color: green; -} -``` +`@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 @@ -303,3 +295,40 @@ When selectors become this long, you're likely writing CSS that is: Again: **never nest ID selectors!** 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. + +**[⬆ back to top](#table-of-contents)** + +## Translation + + This style guide is also available in other languages: + + - ![id](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Indonesia.png) **Bahasa Indonesia**: [mazipan/css-style-guide](https://github.com/mazipan/css-style-guide) + - ![tw](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Taiwan.png) **Chinese (Traditional)**: [ArvinH/css-style-guide](https://github.com/ArvinH/css-style-guide) + - ![cn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/China.png) **Chinese (Simplified)**: [Zhangjd/css-style-guide](https://github.com/Zhangjd/css-style-guide) + - ![fr](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/France.png) **French**: [mat-u/css-style-guide](https://github.com/mat-u/css-style-guide) + - ![ka](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Georgia.png) **Georgian**: [DavidKadaria/css-style-guide](https://github.com/davidkadaria/css-style-guide) + - ![ja](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Japan.png) **Japanese**: [nao215/css-style-guide](https://github.com/nao215/css-style-guide) + - ![ko](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/South-Korea.png) **Korean**: [CodeMakeBros/css-style-guide](https://github.com/CodeMakeBros/css-style-guide) + - ![PT-BR](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Brazil.png) **Portuguese (Brazil)**: [felipevolpatto/css-style-guide](https://github.com/felipevolpatto/css-style-guide) + - ![pt-PT](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Portugal.png) **Portuguese (Portugal)**: [SandroMiguel/airbnb-css-style-guide](https://github.com/SandroMiguel/airbnb-css-style-guide) + - ![ru](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Russia.png) **Russian**: [rtplv/airbnb-css-ru](https://github.com/rtplv/airbnb-css-ru) + - ![es](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Spain.png) **Spanish**: [ismamz/guia-de-estilo-css](https://github.com/ismamz/guia-de-estilo-css) + - ![vn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Vietnam.png) **Vietnamese**: [trungk18/css-style-guide](https://github.com/trungk18/css-style-guide) + - ![vn](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Italy.png) **Italian**: [antoniofull/linee-guida-css](https://github.com/antoniofull/linee-guida-css) + - ![de](https://raw.githubusercontent.com/gosquared/flags/master/flags/flags/shiny/24/Germany.png) **German**: [tderflinger/css-styleguide](https://github.com/tderflinger/css-styleguide) + +**[⬆ back to top](#table-of-contents)** + +## License + +(The MIT License) + +Copyright (c) 2015 Airbnb + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +**[⬆ back to top](#table-of-contents)**