Skip to main content

​
Properties

​
string
required
The type of setting input. Available types:
​
string
required
Unique identifier for the setting. Must be unique within the section.
​
string
required
The label shown in the theme editor for this setting. It may be translated using t: prefix plus a valid key from schema translation files. More details can be found in Locales.
​
any
Default value for the setting. Type depends on the setting type.
​
string
Additional information shown below the setting in the theme editor. It may be translated using t: prefix plus a valid key from schema translation files. More details can be found in Locales.
​
array
For select settings, an array of options with value, label and icon properties.
​
number
For range settings, the minimum allowed value.
​
number
For range settings, the maximum allowed value.
​
number
For range settings, the step increment.
​
string
For range settings, the unit to display (e.g., “px”, “sec”).
​
object
Additional properties for the setting. Currently supported:
  • hidden: boolean value, indicates whether this setting should be displayed in Theme Editor’s configuration bar
  • validations: Apply validations to this setting before saving. Currently supported:
    • required: Boolean value. If true, this setting must be filled with a valid value