SCSS Code Style
ScandiPWA follows a strict SCSS style guide for maintainability and consistency
ScandiPWA follows the BEM methodology to write styles. In addition, there are some guidelines to help you write more maintainable stylesheets.
We strongly recommend you use Stylelint to check your code style. This article was written to help you understand the code style rules we enforce and write better code.
Avoid using selectors that aren't Block-Element-Modifier classes:
component/CheckoutOrderSummary/CheckoutOrderSummary.style.scss (fragment)
.CheckoutOrderSummary {
&-CartItemDescription {
margin-top: 5px;
p {
font-size: 1.1rem;
line-height: 1.5;
}
}
}
Potential issues:
- As code becomes more complex, it can become unclear what role the
pplays in the app. A well-named BEM class would describe its purpose better - Unnecessary coupling: JavaScript code is now forced to use a
<p>element. If you want to rewrite the component to use a<div>instead, you would have to update the styles. - Unnecessary specificity: Having an additional selector element will increase the specificity and make the styles harder to override in
.override.style.scssfiles.
Instead, it is recommended to assign a new BEM class to the element you want to style. Then, you can select it properly:
.CheckoutOrderSummary {
&-CartItemDescription {
margin-top: 5px;
}
&-CartItemDescriptionContent {
font-size: 1.1rem;
line-height: 1.5;
}
}
In some cases, you might need to style one Block differently depending on whether it is a child of another block.
Avoid nesting selectors - don't select a block nested inside another block:
.Button {
margin: 5px;
}
// this is discouraged
.ContactForm .Button {
margin: 10px;
}
This is discouraged for several reasons:
Buttonstyles now contain selectors from another component. This causes coupling, which will result in issues if the.ContactFormblock is renamed- The selector has higher specificity, making it harder to override.
Instead, consider using a variable to customize your styling:
Button.style.scss
:root {
--button-margin: 5px;
}
.Button {
// by default, a value of 5px will be inherited from :root
margin: var(--button-margin);
}
ContactForm.style.scss
.ContactForm {
// we can set the variable lower in the hierarchy to override it
--button-margin: 10px;
}
Now, each component is responsible for its own styles only, and the specificity is still low.
In this case, another possible solution would be to use a Modifier:
.Button {
margin: 5px;
&_margin_large {
margin: 10px;
}
}
Now, the button could take a prop to specify the margin size and add it as a modifier to the Button Block. Then, the ContactForm would have to pass a value to this prop indicating that the button should have a larger margin.
Mobile-first styling means that you are encouraged to start with mobile styles. When mobile styles are complete, you can use the
@include desktop directive and other breakpoints to adjust the styling for larger viewports.You should avoid hard-coding numbers when their reasoning is not obvious. Make values re-usable and understandable by using CSS variables.
Avoid hard-coded values:
.NotificationList {
position: fixed;
top: 110px;
}
Issues:
- Unclear where the value 110 is coming from
- The layout can break if some values are changed
Instead, use variables, and combine them with
calc if necessary:.NotificationList {
position: fixed;
top: calc(var(--header-height) + var(--breadcrumbs-height) + 20px);
}
Advantages:
- Intentions are more clear
- Variable values can be safely changed to adjust the layout
- Each value is re-usable.
Unless you need to produce a pixel-perfect design, we recommend using values rounded to the nearest 5px, avoid unnecessary decimal digits, and consider how much precision browsers can actually display.
Last modified 1yr ago