Skip to main content
The checkbox input type allows users to toggle a boolean value on or off.

​
Properties

​
string
required
Must be set to “checkbox”.
​
string
required
Unique identifier for the setting.
​
string
required
The label shown next to the checkbox.
​
boolean
Default state of the checkbox. Default is false.
​
string
Additional information shown below the checkbox.
​
object
Additional properties for the checkbox. 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 checkbox must be checked to be valid