Skip to main content

Select Items

The items object that contains all of the selectable elements in a single-select or multi-select step type.

{
"name_of_step": {
"type": "multi-select",
"layout": "cards",
"style": "classic",
"title": "",
"dialogue_title": "",
"dialogue_title": "",
"items": [
{
"title": "I'm looking for a specific product",
"description": "Some description text for this tile",
"img": "mockup1.jpeg",
"value": "Product"
},
{
"title": "I want to discuss skin concerns",
"description": "Some description text for this tile",
"img": "mockup2.jpeg",
"value": "Discuss"
}
]
}
}
caution

The value(s) will be stored in the database when the user selects a particular item and submits the form if and only if it has been added to the metadata settings. Think of this property as a hidden attribute tied to each item input option.

info

This value is used for the conditional logic rules set within the logic flow settings. This opens up the possibility of conditionally showing the next step based on the user's selections. See Logic Flow.

Schema Overview

title
string

If there is no image defined for the item the title will be the first content shown on the selectable component.

description
string

The description is the lowest priority content and will be truncated with an ellipsis if the text is too lengthy.

img
string

If provided, the image is the first content to appear on a selectable item. The img property is either a relative path to the image asset or a url.

img_hover
string

The image the shows on mouse hover that's either a relative path to the image asset or a url.

value
string

The value property stores hidden data based on user selections. When a user selects an item from the items, the selection values can either be sent to the database or used in conditional Flow Logic.

filter_priority
boolean

If provided, the image is the first content to appear on a selectable component. The img property is either a relative image url path to the image asset or a url.

is_reset_item
boolean (ResetItem)

Clears all previously selected values from a multi-select step. This is particularly useful for an "All of the Above" item.

{
  • "title": "Chocolate",
  • "description": "Dark",
  • "img": "darkChocolate-light-background.jpeg",
  • "img_hover": "darkChocolate-dark-backgroun.jpeg",
  • "value": "selected_dark_chocolate",
  • "filter_priority": "darkChocolate.jpeg",
  • "is_reset_item": true
}

Full Specification

Loading ....

Example

title
string

If there is no image defined for the item the title will be the first content shown on the selectable component.

description
string

The description is the lowest priority content and will be truncated with an ellipsis if the text is too lengthy.

img
string

If provided, the image is the first content to appear on a selectable item. The img property is either a relative path to the image asset or a url.

img_hover
string

The image the shows on mouse hover that's either a relative path to the image asset or a url.

value
string

The value property stores hidden data based on user selections. When a user selects an item from the items, the selection values can either be sent to the database or used in conditional Flow Logic.

filter_priority
boolean

If provided, the image is the first content to appear on a selectable component. The img property is either a relative image url path to the image asset or a url.

is_reset_item
boolean (ResetItem)

Clears all previously selected values from a multi-select step. This is particularly useful for an "All of the Above" item.

{
  • "title": "Chocolate",
  • "description": "Dark",
  • "img": "darkChocolate-light-background.jpeg",
  • "img_hover": "darkChocolate-dark-backgroun.jpeg",
  • "value": "selected_dark_chocolate",
  • "filter_priority": "darkChocolate.jpeg",
  • "is_reset_item": true
}