Build an integration

Canvas objects

A dropdown component is used to capture a choice from the options that you provide. You can submit the value of the select option by using a button component (which will submit all interactive components in the canvas)

When a submit action takes place, the results are given in a hash with the id from the dropdown component used as the key and the id from the chosen option as the value.

Parameter Possible Values Required Function
type dropdown Yes The type of component you are rendering.
id Any string Yes A unique identifier for the component.
options Array (See Below) Yes The list of 2 or more options.
label Any string No The text shown above the dropdown.
value The id of an option No The option that is selected by default.
save_state unsaved saved failed No Styles all options and prevents the action. Default is false. Will be overriden if save_state is saved.
disabled false true No Styles all options and prevents the action. Default is false. Will be overriden if save_state is saved.
action Action object No This can be a Submit Action or URL Action Action.

Option Parameters

Parameter Possible Values Required Function
type option Yes The type of component you are rendering.
id Any string Yes A unique identifier for the option.
text Any string Yes The text shown within this option.
disabled false true No Styles the option and prevents the action. Default is false.