The select input provides creators with a dropdown menu containing predefined options. It’s ideal for scenarios where you need to present a fixed set of choices such as categories, sizes, or configuration options. The selected value is hidden from creators but passed to your plugin for processing.
If you want to generate dynamic options, please use a
search input instead.
Compatibility
Plugin type Availablity Additional notes Content blocks Media source Available as part of the preset filter
and sort
group functionality. Check media source documentation for more details.
Properties
select
- the type of the component
A unique internal-only identifier that is posted to an app’s plugin server to share values inputted by the creator
Creator-facing identifier that is shown in the plugin environment
Array of objects containing label-value pairs for the dropdown options
Placeholder text displayed when no option is selected
Determines whether the creator must make a selection before proceeding
Brief creator-facing explanation that clarifies the component’s purpose and usage
Allows for the field to be shown conditionally. dependent on other fields. See dependencies page for more details. Name of the dependent field
Value for the dependent field required to show this field. To show when any value is inputted, leave out this property.
{
"type" : "select" ,
"name" : "favorite_food" ,
"label" : "Favorite food" ,
"options" : [
{
"label" : "French fries" ,
"value" : "food-id-1"
},
{
"label" : "Hash browns" ,
"value" : "food-id-2"
},
{
"label" : "Potato chips" ,
"value" : "food-id-3"
}
],
"placeholder" : "Select a food..." , // optional
"required" : true , // optional
"help" : "help text shown in tooltip to creator while editing" , // optional
"dependencies" : [
{
"field" : "dependent_field" ,
"value" : "dependent_value" //optional
}
] // optional
}
{
"settings" : {
"favorite_food" : "food-id-2"
// ...additional plugin settings
}
// ...plugin-specific additional data
}