Customize theme styles

Let's say you created a new theme inheriting from Blank or Luma, and chose the Less compilation mode. What's next? Where to add the style changes? This topic gives quick answers.

Extend parent styles

To extend the parent theme's styles in your theme:

1. In your theme directory, create a web/css/source sub-directory.

2. Create a _extend.less file there. The path to it looks like following:

   Copy
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_extend.less
   ...
   Copied to your clipboard
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_extend.less
   ...

3. Add your Less code in this file.

However, the above only works if the theme's parent is a Blank. Consider a Theme A which is the child of Blank. Theme A has two children, B and C. A global style rule is added to the _extend.less file of theme A. This extends its parent Blank. Theme B and C also have their own _extend.less files. Theme B and C will override the parent (Theme A), rather than extending it further. Theme B & Theme C are extending their grandparent (Blank) and overriding their parent (Theme A) in this setup.

In case of subsequent descendants of the child theme, you can avoid this behavior by following these steps:

1. Create a _extend-child.less in both your parent and child themes.

2. Keep _extend-child.less empty in your parent theme and add it too your parent theme's _extend.less file.

3. Add a @import '_extend-child.less' rule to the end of your parent's theme's _extend.less file.

4. In your child theme, add @import or style rules in _extend-child.less to extend parent theme's CSS.

   Copy
   app/design/frontend/Vendor/
   ├── parent
   │   └── web
   │       └── css
   │           └── source
   │               ├── _extend-child.less (keep this file empty)
   │               └── _extend.less
   └── child
       └── web
           └── css
               └── source
                   └── _extend-child.less
   ...
   Copied to your clipboard
   app/design/frontend/Vendor/
   ├── parent
   │   └── web
   │       └── css
   │           └── source
   │               ├── _extend-child.less (keep this file empty)
   │               └── _extend.less
   └── child
       └── web
           └── css
               └── source
                   └── _extend-child.less
   ...

Extending a theme using _extend.less is the simplest option when you are happy with everything the parent theme has, but want to add more styles.

Override parent styles

To override parent styles (that is, override default UI library variables):

1. In your theme directory, create a web/css/source sub-directory.

2. Create a _theme.less file here. The path to it then looks like following:

   Copy
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_theme.less
   ...
   Copied to your clipboard
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_theme.less
   ...

   It is important to remember that your _theme.less overrides the parent _theme.less.

3. Copy all variables you need from the parent _theme.less, including those which will not be changed. For example, if your theme inherits from Blank, the _theme.less you should copy from is located at <Magento_Blank_theme_dir>/web/css/source/_theme.less.

4. Make the necessary changes.

The drawback of this approach is that you need to monitor and manually update your files whenever the parent's _theme.less is updated.

Add structured changes

To make your changes easier to read and support, structure them by adding a separate overriding or extending .less files for each UI library component you change. Let's use the button component implemented in _button.less as an illustration.

Extend component styles

1. In your theme directory, create a web/css/source sub-directory.

2. Add _buttons_extend.less and _extend.less here. The path to the files looks like following:

   Copy
   <theme_dir>
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_buttons_extend.less
   │  │   │       ├──_extend.less
   ...
   Copied to your clipboard
   <theme_dir>
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_buttons_extend.less
   │  │   │       ├──_extend.less
   ...

3. In _buttons_extend.less add your styles for the button component.

4. In _extend.less register the _buttons_extend.less by adding the following code: @import '_buttons_extend.less';

Override component styles

To override the parent theme's styles for buttons in your theme:

1. In your theme directory, create a web/css/source sub-directory.

2. Create a _buttons.less file here. The path to it looks like following:

   Copy
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_buttons.less
   ...
   Copied to your clipboard
   <theme_dir>/
   │  ├── web/
   │  │   ├── css/
   │  │   │   ├── source/
   │  │   │       ├──_buttons.less
   ...

   This file overrides the _buttons.less of the parent theme.

3. Add your styles for the button component. If the file is left blank, then no styles are applied for the component.

Extend module styles

To extend a Module's styles in your theme:

1. In your theme directory, create a Module_Name/web/css/source directory.

2. Create an _extend.less file in the theme directory. For example:

   Copy
   <theme_dir>/
   ├── <module_dir>/
   │   ├── web/
   │   │   ├── css/
   │   │   │   ├── source/
                   ├──_extend.less
   ...
   Copied to your clipboard
   <theme_dir>/
   ├── <module_dir>/
   │   ├── web/
   │   │   ├── css/
   │   │   │   ├── source/
                   ├──_extend.less
   ...

3. Add additional styles in the _extend.less file.

For example, to extend the Magento_Review module's style, the directory path should be <your_theme_dir>/Magento_Review/web/css/source/_extend.less.

Override module styles

To override module styles in your theme:

1. In your theme directory, create a Module_Name/web/css/source directory.

2. Create a _module.less file in the theme directory. For example:

   Copy
   <theme_dir>/
   ├── <module_dir>/
   │   ├── web/
   │   │   ├── css/
   │   │   │   ├── source/
   |   |   |       ├──_module.less
   ...
   Copied to your clipboard
   <theme_dir>/
   ├── <module_dir>/
   │   ├── web/
   │   │   ├── css/
   │   │   │   ├── source/
   |   |   |       ├──_module.less
   ...

   This file overrides the _module.less file of the specific module.

3. Add your styles in the _module.less file.

For example, to override the Magento_Review module's style, the directory path should be <your_theme_dir>/Magento_Review/web/css/source/_module.less.