Section schema
{% schema %} tag for sections allows you to define the following section attributes and settings:
These attributes and settings enable different customization options and preconfigurations of the section inside the theme editor.
The {% schema %} tag is a Liquid tag. However, it doesn't output its contents, or render any Liquid included inside it.
The following is an example of a valid section schema for the Slideshow section:
/sections/slideshow.liquid
Each section can have only a single {% schema %} tag, which must contain only valid JSON using the attributes listed below. The tag can be placed anywhere within the section file, but it can't be nested inside another Liquid tag.
Having more than one {% schema %} tag, or placing it inside another Liquid tag, will result in a syntax error when editing your theme code.
Consider making your section compatible with app blocks. When you create app blocks, merchants can add app content to their theme without directly editing their theme code.
Anchor to namename
The name attribute determines the section title that is shown in the theme editor. For example, the following schema returns the following output:
Output
By default, when Shopify renders a section, it's wrapped in a <div> element with a unique id attribute:
If you don't want to use a <div>, then you can specify which kind of HTML element to use with the tag attribute. The following are the accepted values:
articleasidedivfooterheadersection
For example, the following schema returns the following output:
/sections/slideshow.liquid
Output
Anchor to classclass
When Shopify renders a section, it's wrapped in an HTML element with a class of shopify-section. You can add to that class with the class attribute:
/sections/slideshow.liquid
Output
Anchor to limitlimit
By default, there's no limit to how many times a section can be added to a template or section group. You can specify a limit of 1 or 2 with the limit attribute:
/sections/slideshow.liquid
Anchor to settingssettings
You can create section specific settings to allow merchants to customize the section with the settings object:
/sections/slideshow.liquid
All section setting IDs must be unique within each section. Having duplicate IDs within a section will result in an error.
Anchor to Access section settingsAccess section settings
Section settings can be accessed through the section object. Refer to Access settings to learn more.
If a section is statically rendered, then there's only one instance of the section across all static renderings, as a result they all share the same section setting values.
Anchor to blocksblocks
You can create blocks for a section. Blocks are reusable modules of content that can be added, removed, and reordered within a section.
Blocks have the following attributes:
| Attribute | Description | Required |
|---|---|---|
type | The block type. This is a free-form string that you can use as an identifier. You can access this value through the type attribute of the block object. | Yes |
name | The block name, which will show as the block title in the theme editor. | Yes |
limit | The number of blocks of this type that can be used. | No |
settings | Any input or sidebar settings that you want for the block. Certain settings might be used as the title of the block in the theme editor. | No |
The following is an example of including blocks in a section:
/sections/slideshow.liquid
All block names and types must be unique within each section, and all setting IDs must be unique within each block. Having duplicates will result in an error.
Anchor to Access block settingsAccess block settings
Block settings can be accessed through the block object. Refer to Access settings to learn more.
If a section is statically rendered, then there's only one instance of the section across all static renderings, meaning they all share the same block setting values.
Anchor to Render blocksRender blocks
You can render a section's blocks by looping over the blocks attribute of the section object:
In the example above, each block's content is included inside a parent container, and that container has {{ block.shopify_attributes }} added as an attribute. Shopify's theme editor uses that attribute to identify blocks in its JavaScript API.
If your block is a single element, then ensure that the element has this attribute.
Don't rely on the literal value of a block's ID when you iterate over blocks. The ID is dynamically generated and is subject to change. The following is an example of relying on a literal value of a block's ID, which may break functionality in your theme if the ID changes:
Anchor to Recommended blocksRecommended blocks
You can highlight specific theme blocks in the block picker to make them easier to find. To do this, include the @theme block type along with your recommended blocks in the blocks array.
In this example, the text, button, and _marquee blocks appear immediately in the picker. Other available theme blocks remain accessible by selecting Show all.
Block picker with recommended blocks
Anchor to Show dynamic block titles in the theme editorShow dynamic block titles in the theme editor
In certain cases, the theme editor can display an input setting value as the title of a block in the theme editor sidebar. This can help merchants to identify and rearrange blocks in a section.
The theme editor checks the id values of the settings in a block to determine the best one to use for the block title.
The theme editor uses settings with the following id values, in order of precedence:
headingtitletext
If a setting with a matching id value doesn't exist, then the block name is used as the title.
For example, this block with a setting id of heading displays in the sidebar with the title Welcome to our store.
File
Anchor to max_blocksmax_
There's a limit of 50 blocks per section. You can specify a lower limit with the max_blocks attribute.
Static blocks don't count toward this limit.
/sections/slideshow.liquid
Example
Anchor to presetspresets
Presets are predefined section configurations that merchants can select when adding sections to a JSON template. Presets help you quickly provide merchants with different layouts and use cases by adjusting section settings. For example, a "Testimonials" section might include presets for a single testimonial, a carousel, and a grid layout.
Section presets are different from the presets used to define theme presets in the settings_data.json file.
Presets appear in the Add section picker as follows:
Add section interface
| Number | Description |
|---|---|
| 1 | Presets appear alphabetically based on their name attribute. |
| 2 | Presets can optionally be grouped into collapsible categories using the category attribute. |
| 3 | Uncategorized presets are always displayed first. |
| 4 | The theme editor automatically generates a preset preview. You can further customize this preview using visual preview mode. |
Section presets have the following attributes:
| Attribute | Description | Required |
|---|---|---|
name | The preset name displayed in the theme editor's Add section picker and sidebar, and is persisted in the JSON template when you add a section. | Yes |
category | Groups related presets together in the theme editor's Add section picker. | No |
settings | Default values for settings you want to pre-populate. Each entry includes the setting name and its value. | No |
blocks | Default blocks included in the preset. Each block entry must include a type attribute matching the block type, and a settings object formatted similarly to the settings attribute above. Optionally, include a name attribute to display when merchants add the block in the editor. | No |
Here's an example of how presets are defined within a section schema:
/sections/slideshow.liquid
Sections with presets shouldn't be statically rendered. If you're going to statically render a section, then you should use default settings.
Anchor to defaultdefault
If you statically render a section, then you can define a default configuration with the default object, which has the same attributes as the preset object.
The following is an example of including a default in a section:
/sections/slideshow.liquid
You should only use the section default attribute for sections that will be reused, or installed on multiple themes or shops. Statically rendered sections that come pre-installed on a theme should have their default configuration defined by the default attribute for each individual setting.
Anchor to localeslocales
Sections can provide their own set of translated strings through the locales object. This is separate from the locales directory of the theme, which makes it a useful feature for sections that are meant to be installed on multiple themes or shops.
The locales object has the following general format:
General format
For example:
/sections/slideshow.liquid
Any translations will show up under the Sections tab of the language editor for merchants to edit. When edits are made, the changes are saved directly to the applicable locale file, and the section schema is unchanged.
These translations can be accessed through the Liquid translation filter (t filter) where the key will be in the following format:
For example, if you want to reference the title translation from the example above, then use the following:
Anchor to enabled_onenabled_
You can restrict a section to certain template page types and section group types by specifying them through the enabled_on attribute.
enabled_on, along with disabled_on, replaces the templates attribute.
You can use only one of enabled_on or disabled_on.
enabled_on must have at least one of the following attributes:
| Attribute | Description |
|---|---|
templates | A list of the template page types where the section can be used. Accepted values:
|
groups | A list of the section groups where the section can be used. Accepted values:
|
In the following example, the section is available to all templates, and to the footer section group:
/sections/slideshow.liquid
Anchor to disabled_ondisabled_
You can prevent a section from being used on certain template page types and section group types by setting them in the disabled_on attribute. When you use disabled_on, the section is available to all templates and section groups except the ones that you specified.
disabled_on, along with enabled_on, replaces the templates attribute.
You can use only one of enabled_on or disabled_on.
disabled_on must have at least one of the following attributes:
| Attribute | Description |
|---|---|
templates | A list of the template page types where the section can't be used. Accepted values:
|
groups | A list of the section groups where the section can't be used. Accepted values:
|
In the following example, the section is available to all templates other than password templates, and to all section groups other than footer section groups.