AppsThemesSupport

Overview

Suggest Edits

Layouts are the base of the theme, through which all templates are rendered.

Layouts are Liquid files that allow you to include content, that should be repeated on multiple page types, in a single location. For example, layouts are a good place to include any content you might want in your <head> element, as well as headers and footers.

You can edit the default theme.liquid layout, or you can create multiple custom layout files to suit your needs. You can specify which layout to use, or whether to use a layout at all, at the template level:

  • In Liquid templates, the layout that's used to render a page is specified using the layout attribute.

Location

Layout files are located in the layout directory of the theme:

└── theme
    ├── layout
    |   ├── theme.liquid
    |   ...
    ├── templates
    ...

Subtypes

There are the following layout types:

TypeDescription
GeneralGeneral layouts can apply to all pages.

The default layout file, which must be included in all themes, is theme.liquid.
PasswordThis layout type applies to the password access page, which is password.liquid.

Schema

Because layout files are the base of the theme, they should follow the structure of a standard HTML document in most cases. Most layout files also contain the following Liquid objects:

<!DOCTYPE html>
<html>
  <head>
    ...
    {{ content_for_header }}
  </head>

  <body>
    ...
    {{ content_for_layout }}
    ...

    {{ content_for_js }}
    ...
  </body>
 </html>

Content

Layouts allow you to include content that's repeated across multiple page types in a single location. For example, layouts might include header and footer sections and SEO metadata.

Layout files are .liquid files, so content can be built using standard HTML and Liquid.

Layouts can access any global Liquid objects and can contain the following Liquid objects:

🚧

Caution

These objects are required in theme.liquid. If references to these objects aren't included, then you can't save or update the file using the code editor or tools like Shoplazza CLI.

content_for_header

The content_for_header object is required in theme.liquid. It must be placed inside the HTML <head> tag. It dynamically loads all scripts required by Shoplazza into the document head. These scripts are required for features like reCAPTCHA, Shoplazza apps, and more.

You shouldn't try to modify or parse the content_for_header object. If content_for_header changes, then the behavior of your Liquid will change.

content_for_layout

The content_for_layout object dynamically outputs the content for each template. You need to add a reference to this object between the <body> and </body> HTML tags.

Usage

When working with layout files, you should familiarize yourself with the following concepts:

Support template-specific CSS selectors

You can help create CSS rules for specific templates by outputting data from the template object in the <body> tag’s class.

<body class="template-{{ template.name }}">
  ...
</body>

.template-product {
  margin-top: 100px;
  margin-bottom: 100px;
}

Updated 10 months ago