Overview

Configuration files define the settings area within the theme editor and store configured values.

Theme settings include configurations for typography, fonts, and colors, and can be accessed via theme.settings.

Tip

You can also create settings in sections and blocks. These settings become part of the parent section or block objects and appear in the theme editor associated with those objects.


Location

Configuration files are located in the config directory:

└── theme
...
├── config
├── settings_data.json
└── settings_schema.json

File Types

There are two types of configuration files, each with its own structure and content:

TypeDescriptionRequired
settings_data.jsonStores values configured by settings_schema.jsonYes
settings_schema.jsonControls the settings and content in the theme settings of the theme editorYes

Usage

When using configuration files, you should be familiar with the following:

Setting Types

There are two types of settings:

TypeDescription
Input SettingsThese settings can save the values configured by the user
Sidebar SettingsThese settings do not store values and cannot be configured. They describe controls, provide categorization, and tips for more accurate data entry

Access Settings

Theme settings can be accessed through theme.settings. For more information on syntax, precautions, and related details, refer to Settings.

Theme Metadata

You can add theme metadata to the Theme Actions menu in the theme editor. This includes the theme name and version, the location of theme documentation, and contact information for the theme developer. For information on how to include this in your theme, see Adding Theme Metadata.

Was this article helpful to you?

Error loading component.

Error loading component.