io.select.multiple
Prompts the app user to select any number of values from a set of provided values.
Usage
const condiments = await io.select.multiple("Condiments", {
options: [
{
label: "Ketchup",
value: 0,
},
{
label: "Mustard",
value: 1,
},
{
label: "Mayo",
value: 2,
},
],
defaultValue: [
{
label: "Ketchup",
value: 0,
},
{
label: "Mustard",
value: 1,
},
],
helpText: "What goes on it?",
});
const condimentIds = condiments.map(condiment => condiment.value);
interval.com
Props
defaultValue | Optional array of strings or objects | Default preselected options. Must be a subset of defined options. |
helpText | Optional string | Secondary label providing additional context for the selection. |
maxSelections | Optional number | Maximum number of selected values accepted for submission. |
minSelections | Optional number | Minimum number of selected values required for submission, defaults to 0. |
options | Required array of strings or objects | Array of possible values to be selected. |
Returns: A subset of the provided options.
Examples
String options
The options
property can also be an array of strings, which is equivalent to
objects with identical label
and value
properties with the string values.
Strings will be returned if this form is used.
const condimentNames = await io.select.multiple("Condiments", {
options: ["Ketchup", "Mustard", "Mayo"],
defaultValue: ["Ketchup", "Mustard"],
helpText: "What goes on it?",
});
Did this section clearly explain what you wanted to learn?