Skip to main content
The toggle allows creators to enable or disable specific features through a simple boolean switch interface. It’s perfect for optional configurations like custom descriptions, showing or hiding elements, applying filters, or turning functionality on and off. The toggle provides clear visual feedback about the current state of the setting. example toggle
Fields dependent on toggles will only show when the toggle is switched on (i.e. has a value true).

​
Compatibility

Plugin typeAvailabilityAdditional notes
Content blocks
Media source

​
Properties

​
type
string
required
toggle - the type of the component
​
name
string
required
A unique internal-only identifier that is posted to an app’s plugin server to share values inputted by the creator
​
label
string
required
Creator-facing identifier that is shown in the plugin environment (64 character limit)
​
default
boolean
Default state of the toggle when the component first loads
​
required
boolean
Determines whether the creator must interact with the toggle before proceeding
​
help
string
Brief creator-facing explanation that clarifies the component’s purpose and usage (256 character limit. Supports markdown: [text](url), **bold**, and *italic*)
​
dependencies
object array
Allows for the field to be shown conditionally. dependent on other fields. See dependencies page for more details.
  {
    "type": "toggle",
    "name": "optional_toggle",
    "label": "Optional Toggle",
    "default": false, // optional
    "required": false, // optional
    "help": "Helping you understand what this toggle does", //optional
    "dependencies": [
      {
          "field": "dependent_field",
          "value": "dependent_value" //optional
      }
    ] // optional
  }

  {
    "settings": {
      "optional_toggle": true
      // ...additional plugin settings
    }
    // ...plugin-specific additional data
  }