The SXA themes

Abstract

Learn more about SXA site themes and base themes.

Themes define the look and feel of a site and can be created separately from the site functionality and content. There are two types of themes: base themes and site themes.

SXA comes with the default site theme named Wireframe to help you set up your site quickly. A site can be put together using the Wireframe theme, while in the meantime the base theme is sent to a creative agency using Creative Exchange. When imported back, the site can be re-skinned using the new theme. You can create a new theme by copying the base theme and adding your own classes, applying a style to a particular rendering on a particular page, and adding assets, such as images, fonts, and files.

To automate theme creation you can use the SXA CLI command line tool. This can be convenient if you want to have more control over your assets and use a version control system, such as Git. SXA also lets you use pre-optimized-min files for uploading styles and scripts.

Base themes are prototype themes that predetermine the layout of a website. You can have several base themes to support different design philosophies or specific functionality.

Note

Do not change base themes because these are part of the platform. If the base themes do not suit your needs, it is better to create a new base theme to inherit from.

Keep the Protected Theme checkbox selected for base themes. If the Protected Theme check box is selected, the theme is added to the <restrictedLocations> setting in Sitecore.XA.Feature.CreativeExchange.config, and changes to CSS/JS are not reflected when imported back using Creative Exchange.

Select Protected theme to add the theme to CE settings.

The base themes are saved in the Media Library: /sitecore/Media Library/Base Themes.

Site themes are extensions of base themes and can be applied to specific sites. Site themes usually have dependency on base themes and contain scripts and styles for all renderings used in a site. The CSS and JavaScript files in themes are divided into chunks that deal with one rendering at a time.

For each site theme, you must select a base theme to define the basic characteristics and properties of the theme. Every theme also needs a grid theme. SXA themes support multiple inheritance. This means that you can define multiple parent themes for every single theme.The order of selected base themes is important. Be careful when you add a new theme or change the order. For example, if the SearchTheme relies on jquery library that is located in Core Libraries, you must make sure that the SearchTheme is loaded after the other themes.

By default, a theme contains folders for fonts, images, scripts, and styles:

Site theme name

Folder

Required

Description

fonts

Not required

An example of how you could organize your fonts assets. This folder is optional and can be named differently.

images

Required

An example of how you could organize your images assets. Although not directly required by SXA, some CSS may use image references to a set path.

scripts

Required

Use to add your scripts or to delete unused scripts. Elements nearer to the top are loaded faster.

styles

Required

Use to add or delete styles.

Note

You must not add folders under the styles and scripts folders. You can place your scripts and styles directly in the folders, without nested structure.

If you use preoptimization for your scripts and styles, the theme's styles and scripts folders only contains the pre-optimized-min file and not the source assets.

SXA-preoptimizedmin-CE.png

SXA comes with the default site theme named Wireframe to help you set up your site quickly. A site can be put together using the Wireframe theme, while in the meantime the base theme is sent to a creative agency using Creative Exchange. You can swap the Wireframe theme with a site theme once it has been prepared by your front-end developers.

Wireframe

If you want to use mock images for the image placeholders, go to the Wireframe Image section and enter the fields:

  • Mock Image - specify the image that displays as a mock image. If the field is left empty, no image will display.

  • Stretch Image - when selected it stretches the image to full width/height.

  • Background Color - specify the background color for the image in HTML hex format. If the field is left empty, the background will be transparent.

    SXA-wireframe-theme.PNG

When you create a new site and choose to create a new theme, this theme will be a copy of the Basic2 theme. Out of the box, this theme will contain pre-optimized files that should not be edited directly. The content of this theme is only a placeholder for the theme that you will create for your site.

To prepare your theme for working on branding, use the SXA CLI command line tool.

Folder

Required

Description

fonts

Not required

An example of how you could organize your fonts assets. This folder is optional and can be named differently.

images

Required

An example of how you could organize your images assets. Although not directly required by SXA, some CSS may use image references to a set path.

scripts

Required

Stores your pre-optimized script file.

styles

Required

Stores your pre-optimized style file. This file should be created as a result of compiling Sass project files.