Наиболее разумный подход к CSS и Sass
- Терминология - Правило декларации - Селекторы - Свойства
- CSS - Форматирование - Комментарии - Объектно-ориентированный CSS и БЭМ - ID Селектор - Хуки JavaScript - Граница
- Sass - Синтаксис - Порядок объявления свойств - Переменные - Миксины - Extend directive - Вложенные селекторы
- Переводы
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: "Объявление правил" это: имя данное селектору (или группе селекторов) с сопутствующими им свойствами. Например:
.listing {
font-size: 18px;
line-height: 1.2;
}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: В объявление правил, "селекторы" это части которые определяют к какому элементу DOM дерева будут применены правила стилей. Селекторы могут соответствовать HTML элементу, а так-же классу элемента, ID или любому другому атрибуту этого элемента. Вот несколько примеров:
.my-element-class {
/* ... */
}
[aria-hidden] {
/* ... */
}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: И, наконец, свойства, которые дают выбранным элементам их стиль. Свойства объявляются в виде пары "ключ-значение" и объявления правил могут содержать одно или несколько свойств. Объявление свойств может выглядеть так:
/* some selector */ {
background: #f1f1f1;
color: #333;
}- Use soft tabs (2 spaces) for indentation
- Используйте 2 пробела для отступов
- Prefer dashes over camelCasing in class names.
- Отдавайте предпочтение тире в именах классов вместо CamelCase
- Underscores and PascalCasing are okay if you are using BEM (смотри OOCSS and BEM below).
- Подчеркивания и PascalCasing допустимы если вы используете БЭМ (смотри Объектно-ориентированный CSS и БЭМ далее)
- Do not use ID selectors
- Не используйте селекторы по ID
- When using multiple selectors in a rule declaration, give each selector its own line.
- Используя несколько селекторов в объявление правил, переносите каждый селектор на отдельную строку
- 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
- Делайте отступ в одну строку между объявлениями правил.
Плохо
.avatar{
border-radius:50%;
border:2px solid white; }
.no, .nope, .not_good {
// ...
}
#lol-no {
// ...
}Хорошо
.avatar {
border-radius: 50%;
border: 2px solid white;
}
.one,
.selector,
.per-line {
// ...
}- Prefer line comments (
//in Sass-land) to block comments. - Предпочитайте однострочные (
//) комментарии многострочным . - Prefer comments on their own line. Avoid end-of-line comments.
- Рекомендуется писать комментарии в отдельные строки.
- Write detailed comments for code that isn't self-documenting:
- Пишите детальные комментарии для незадокументированных частей кода
- Uses of z-index
- Использование z-index
- Compatibility or browser-specific hacks
- Совместимость или CSS-хаки
We encourage some combination of OOCSS and BEM for these reasons: Мы реккомендуем комбинировать Объектно-ориентированный CSS и БЭМ по следующим причинам:
- It helps create clear, strict relationships between CSS and HTML
- Это помогает создавать чистую свзять между CSS и HTML.
- It helps us create reusable, composable components
- Помогает создавать многоразовые, составные компоненты.
- 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, или "Объектно-ориентированный CSS", это подход к написанию CSS, который призывает думать о таблице стилей, как о коллекции "объектов": многоразовых, повторяемых фрагментах кода, которые могут использоваться независимо друг от друга на всём сайте.
- Nicole Sullivan's OOCSS вики
- Smashing Magazine's Введение в Объектно-ориентированный CSS
BEM, or “Block-Element-Modifier”, is a naming convention for classes in HTML and CSS. It was originally developed by Yandex with large codebases and scalability in mind, and can serve as a solid set of guidelines for implementing OOCSS. БЭМ, или "Блок-Элемент-Модификатор", это соглашение об именовании классов в HTML и CSS. Разработано Яндексом с прицелом на большие объёмы кода и масштабируемость. Может послужить как солидный набор правил для использования OOCSS.
- CSS Trick's БЭМ 101
- Harry Roberts' Введение в БЭМ
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. Мы реккомендуем вариант БЭМ в котором используется PascalCased "блоки", отлично работающие в связке с компонентами (например React). Подчеркивания и тире используются для модификаторов и элементов. Примеры
// ListingCard.jsx
function ListingCard() {
return (
<article class="ListingCard ListingCard--featured">
<h1 class="ListingCard__title">Adorable 2BR in the sunny Mission</h1>
<div class="ListingCard__content">
<p>Vestibulum id ligula porta felis euismod semper.</p>
</div>
</article>
);
}/* ListingCard.css */
.ListingCard { }
.ListingCard--featured { }
.ListingCard__title { }
.ListingCard__content { }.ListingCardis the “block” and represents the higher-level component.ListingCardявляется "блоком" и представляет родительский компонент.ListingCard__titleis an “element” and represents a descendant of.ListingCardthat helps compose the block as a whole..ListingCard__titleявляется "элементом" и представляет дочерний компонент.ListingCardкоторый позволяет составить блок в целом..ListingCard--featuredis a “modifier” and represents a different state or variation on the.ListingCardblock..ListingCard--featuredявляется "модификатором" и представляет разные состояния.ListingCard.
While it is possible to select elements by ID in CSS, it should generally be considered an anti-pattern. ID selectors introduce an unnecessarily high level of specificity to your rule declarations, and they are not reusable. Возможность выбирать элементы по ID в CSS должна, как правило, рассматриваться плохой практикой. ID селекторы предоставляют неоправданно высокий уровень допилить For more on this subject, read CSS Wizardry's article on dealing with specificity. Более подробная информация по этому вопросу: Статья CSS Wizardry
Avoid binding to the same class in both your CSS and JavaScript. Conflating the two often leads to, at a minimum, time wasted during refactoring when a developer must cross-reference each class they are changing, and at its worst, developers being afraid to make changes for fear of breaking functionality.
Избегайте использования одинаковых имён классов в CSS и JavaScript. Использование одинаковых имён классов может привести, как минимум, к трате времени при рефакторинге, и как максимум к боязне разработчика сломать функционал вводом новых изменений.
We recommend creating JavaScript-specific classes to bind to, prefixed with .js-:
Мы реккомендуем создавать отдельные имена классов для JavaScript используя префикс .js-:
<button class="btn btn-primary js-request-to-book">Request to Book</button>Use 0 instead of none to specify that a style has no border.
Bad
.foo {
border: none;
}Good
.foo {
border: 0;
}- Use the
.scsssyntax, never the original.sasssyntax - Всегда используйте
.scssсинтаксис, и никогда, оригинальный.sassсинтаксис. - Order your regular CSS and
@includedeclarations logically (see below) - Упорядочивайте обычный CSS и
@include-объявления логически.
-
Объявления свойств
List all standard property declarations, anything that isn't an
@includeor a nested selector. Перечислите все стандартные свойства объявления, всё что не является@include-объявлением или вложенным селектором.btn-green { background: green; font-weight: bold; // ... }
-
@include-объявленияGrouping
@includes at the end makes it easier to read the entire selector. Группирование@include-объявлений в конце селектора делает его более читаемым..btn-green { background: green; font-weight: bold; @include transition(background 0.5s ease); // ... }
-
Вложенные селекторы
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. Вложенные селекторы, если необходимо, идут последними, и ничего не должно быть после них. Добавьте пробел между объявлением правила и вложенным селектором, а так-же между смежными вложенными селекторами. Примените те же принципы, что и для ваших вложенных селекторов.
.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).
Отдавайте предпочтение именам переменных разделенных тире (например $my-variable). Допускается использование подчеркивания в виде префикса для имён которые будут использоваться в пределах одного файла (например $_my-variable).
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. Миксины должны использоваться для поддержания чистоты и ясности кода, или абстрактной сложности, во многом так же, как и хорошо названные функции. Миксины не принимающие никаких аргументов могут быть полезны для этого, но нужно иметь в виду что если вы не сжимаете свои файлы (например gzip), это может привести к лишнему повторению кода.
@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.
Использование @extend необходимо избегать из-за его неинтуитивного поведения и потенциальной опасности в поведение, особенно при использование вместе с вложенными селекторами. Даже допилить селекторов верхнего уровня может создать проблемы, если в будущем будет изменён порядок селекторов. Сжатие должно обрабатывать большую часть сбережений вы получили бы с помощью допилить.
Do not nest selectors more than three levels deep! Вложенные селекторы не должны быть глубже трёх вложений
.page-container {
.content {
.profile {
// STOP!
}
}
}When selectors become this long, you're likely writing CSS that is: Когда селекторы становятся слишком длинными, скорее всего вы пишите CSS который:
- Strongly coupled to the HTML (fragile) —OR—
- Слишком сильно привязан к HTML (хрупкий) —OR—
- Overly specific (powerful) —OR—
- Слишком специфичен —OR—
- Not reusable
- Не многоразовый —OR—
Again: never nest ID selectors! И вновь: никогда не используйте ID селекторы! 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. Если вы должны использовать ID селектор (вы действительно должно постараться этого не делать), он никогда не должен быть вложен. Если вы обнаружили это в своём коде, вам нужно пересмотреть разметку, или выяснить, почему нужна такая сильная специфика. Если вы пишете хорошо сформированные HTML и CSS, вы никогда не должны делать это.
This style guide is also available in other languages: Этот гид по стилю так-же доступен в других языках:
Chinese (Simplified): Zhangjd/css-style-guide