Developing with Scandi
Tutorials
Overriding Styles
You can adjust the styling of your theme in 3 different ways:
- Overriding the Base Styles: The ScandiPWA theme includes a set of stylesheets in
app/stylethat define the main look of the application. These define global settings, such as SCSS variables (style/abstract/_variables.scss), media query definitions (style/abstract/_media.scss), base styling for some HTML elements (style/base), CMS content styling (style/cms), and more. If you want to make global styling changes to these files, you can override them. - Replacing a Component's Styles: Every component (and route) includes an associated stylesheet, named
<component>.style.scss. If you wish to completely change the look of a component, you can replace these styles with your own. - Partially Overriding a Component's Styles: You can choose to keep the existing component's styles instead, and override some of them.
Overriding the Base Styles
The base styles are defined in the
styles directory, and imported in styles/main.scss. In order to override a base style file, you need to copy over the chain of files that is used to import it.For example, suppose we want to change the main theme color to an ocean blue. The primary color is defined in
style/abstract/_variables.scss. Copy over this file to avoid missing any variables, and make the desired changes:override: style/abstract/_variables.scss
1
$white: #fff;
2
$black: #0a0a0a;
3
$default-primary-base-color: #2387f2; // changed the color here
4
$default-primary-dark-color: #1259d4; // and here
5
$default-primary-light-color: #42bdf7; // and here!
6
$default-secondary-base-color: #eee;
7
$default-secondary-dark-color: #929292;
8
$default-secondary-light-color: #f8f8f8;
9
$font-muli: 'Muli', sans-serif;
10
$font-standard-size: 12px;
11
$font-mobile-size: 14px;
Copied!
We also need to copy over the file that imports
_variables.scss for the override to work. By inspecting the styling files, we can see that style/abstract/_variables.scss is imported in style/abstract/_abstract.scss, which is itself imported directly from style/main.scss. Hence, we need to copy over _abstract.scss and main.scss to their respective directories in our theme.We can check that the theme's primary color has been successfully overridden:
Replacing a Component's Styles
Sometimes you may want to completely restyle a component, ignoring all original styles. For example, suppose we want to create an entirely new design for the
CategoryPaginationLink component. All we need to do is create a stylesheet with the same path as the stylesheet from the parent theme we want to override. In this case, create a file in component/CategoryPaginationLink/CategoryPaginationLink.style.scss with the following contents:override: component/CategoryPaginationLink/CategoryPaginationLink.style.scss
1
:root{
2
--category-pagination-link-size: 50px;
3
--category-pagination-link-text-size: 30px;
4
}
5
6
.CategoryPaginationLink {
7
// configure layout and center text
8
display: block;
9
text-align: center;
10
size: var(--category-pagination-link-text-size);
11
line-height: var(--category-pagination-link-size);
12
13
// set a circular shape with border-radius
14
width: var(--category-pagination-link-size);
15
height: var(--category-pagination-link-size);
16
margin: 6px;
17
border-radius: var(--category-pagination-link-size);
18
19
// white text on a blue background
20
background: var(--primary-base-color);
21
color: #fff;
22
23
// indicate hover/active state
24
transition: opacity 100ms ease-out;
25
opacity: 0.7;
26
27
&:hover,
28
&:focus,
29
&_isCurrent {
30
opacity: 1;
31
}
32
}
Copied!
With this override, any import of the
CategoryPaginationLink stylesheet will resolve to our custom file. Hence, our stylesheet will be the one to be included in the final CSS file, resulting in this look:
Partially Overriding a Component's Styles
In some situations, you might want to keep the overall look of a component but change some minor aspect of it's styling. In such cases, it would be undesirable to copy the original stylesheet just to change a few lines of SCSS rules. ScandiPWA suggests a better approach: keeping the original stylesheet and creating an additional stylesheet that overrides some of the default styles.
Consider an example where we want to change the style of the heading of
MyAccountOverlay - we want to make the text "Sign in to your account" italic.First, we can define the styles we want to change. We can't keep the original name of the file, because then we will override it completely as shown in the previous section. The naming convention for partially overriding stylesheet files in ScandiPWA is to add
.override to the file name:override: component/MyAccountOverlay/MyAccountOverlay.override.style.scss
1
.MyAccountOverlay {
2
&-Heading {
3
font-style: italic;
4
}
5
}
Copied!
The styles we want to override are defined, but they will not be included in the CSS requested by the browser unless we import them somewhere. Styles in ScandiPWA are typically imported from the
.component file, so override the .component file of MyAccountOverlay, by creating a file matching the original component file. We don't need to change any of the exported classes or components, so we can leave the existing exports unchanged, but we do need to add an additional import - our overridden styles:override: component/MyAccountOverlay/MyAccountOverlay.component.js
1
// import the original component so that base styles are applied first
2
import 'SourceComponent/MyAccountOverlay/MyAccountOverlay.component';
3
// import our modified styles to override some of the default ones
4
import './MyAccountOverlay.override.style.scss';
5
6
// re-export all the original exports from the parent theme untouched
7
export * from 'SourceComponent/MyAccountOverlay/MyAccountOverlay.component';
8
export { default } from 'SourceComponent/MyAccountOverlay/MyAccountOverlay.component';
Copied!
Now, we can verify that the new CSS rules have overridden some of the default ones, and the title is in italics:
Last modified 10mo ago