Config files define settings in the Theme settings area of the theme editor, as well as store their values.

The theme settings are an excellent place to host general settings such as typography and color options. The theme settings can be accessed through the settings object.

Location

Config files are located in the config directory of the theme:

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

Subtypes

There are two config files, each with its own schema and content:

TypeDescriptionRequired
settings_schema.jsonControls the organization and content of the Theme settings area of the theme editor.Yes
settings_data.jsonContains the saved values from the settings in settings_schema.json.Yes

Usage

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

Setting types

There are two categories of settings:

CategoryDescription
Input settingsSettings that can hold a value, and are configurable by app users.
Sidebar settingsSettings that can’t hold a value, and aren’t configurable by app users. They’re informational elements that can be used to provide detail and clarity for your input settings.

Access settings

The theme settings can be accessed through the settings object. To learn more about the syntax and considerations, refer to Access settings.