Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.kit.com/llms.txt

Use this file to discover all available pages before exploring further.

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.
example select input

​
Compatibility

Plugin typeAvailabilityAdditional notes
Content blocks
Media sourceAvailable as part of the preset filter and sort group functionality. Check media source documentation for more details.

​
Properties

​
type
string
required
select - 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
​
options
array
required
Array of objects containing label-value pairs for the dropdown options
​
placeholder
string
Placeholder text displayed when no option is selected
​
default
string
Default option value that is pre-selected when the component first loads
​
required
boolean
Determines whether the creator must make a selection 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": "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
    "default": "food-id-1", // 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
  }