Select

A selection from predefined values

Specification

multiple

• Type: Boolean

• Default: false

• If true, multiple selections are allowed.

sort

• Type: String

• Allowed values: text or number

• Items are unsorted by default. However, you can sort them using this option.

grouped

• Type: Boolean

• If true, options can be grouped by using grouped options syntax.

Example

[
    {
        label: "Group",
        options: [
            {
                label: "Option",
                value: 1
            }
        ]
    }
]

options

Available types:

Type	Specification
array	An array of options for this select field. Example: [ { label: "Option", value: 1 } ]
string	Specifies an options RPC URL that retrieves dynamic options for this selection.
object	Allows specifying the detailed configuration of options and nested parameters for this select field.

Available parameters:

Parameter	Type	Specification
store	array	Specifies options for the select field.
store	string	Specifies an options RPC URL that retrieves dynamic options for the select.
label	string	Specifies the name of a property as the label of an option.
value	string	Specifies the name of a property as the value of an option. Value cannot be null.
placeholder	string	Specifies the label shown when no option is selected. Available parameters: label (string) - Specifies the label shown when no option is selected. nested (array) - Specifies an array of nested parameters shown when no option is selected.
placeholder	object	Specifies a detailed configuration of a placeholder. Available parameters: label (string) - Specifies the label shown when no option is selected. nested (array) - Specifies an array of nested parameters shown when no option is selected.
nested	array	Specifies an array of nested parameters shown when an option is selected. When the select is multiple, the nested parameters are generated and displayed for the selected options.
nested	string	Specifies an RPC URL that retrieves dynamic nested options.

mode

• Type: String.

• Accepted values: edit or choose.

validate

• Type: Object or Boolean.

• Specifies parameter validation.

When set to false, the validation against the provided options gets disabled for manual input.

Available parameters:

Parameter	Type	Specification
maxItems	number	Specifies the maximum number of selected items when multiple is true.
minItems	number	Specifies the minimum number of selected items when multiple is true.

spec

• Type: Object.

Available parameters:

Parameter	Type	Specification
type	string	Specifies a data type of value from the select that is validated. Useful when your API returns numerical IDs in strings but you want them to be typed as numbers in the output of your module.

dynamic

• Type: Boolean

• Default: false

Defines whether a mapped value in the select should be validated against the option values.

If true, the value is treated as dynamic and validation is disabled. The value is set to true automatically if select options are generated using an RPC.

mappable

• Type: Boolean or Object

  • Set to false to make field non-mappable.

  • If Object, it specifies the detailed configuration of the mapping toggle.

Available parameters:

Parameter	Type	Specification
help	string	Alternative help text is shown only when the mappable toggle is turned on.

Examples

Basic select

A basic select with few options that can't be changed manually.

Appearance

Source

Select with grouped options

Sort options into groups by enabling grouped options.

Appearance

Source

Multiple choice

Turn on multiple choice by setting multiple to true.

Appearance

Source

Output

Multiple choice with validation

You can validate the number of selected options by using validate object.

Appearance

Source

Mappable select with help

You can display a custom help message when the mappable toggle is turned on.

Appearance

Source

Preselected value

Set a preselected value by setting a default. The value of desired option and default has to match.

Appearance

Source

Placeholder

Choose what to display when no option is selected by specifying a placeholder. You need to put options inside the store array to make this work.

Appearance

Source

Nested options

Use nested options to display a set of fields when an option is selected.

Appearance

Source

Nested fields for specific options

Display certain fields only when a specific option is selected. In this case, you can nest fields under a specific option.

Appearance

Source

Select under select

This is a special case of nested options that is used to specify a category and its subcategory.

Appearance

Source

Mode edit as default

When your select is editable, you can set the default mode edit.

Appearance

Source

Nested RPCs

Nest RPCs when retrieving nested fields dynamically. The nested RPC receives the id parameter automatically.

Source

[
   {
       "name": "id",
       "type": "select",
       "mode": "edit",
       "options": {
           "store": "rpc://listBoards",
           "nested": [
               {
                   "name": "member_id",
                   "type": "select",
                   "label": "Member",
                   "options": "rpc://getMemberIdBoard",
                   "required": true
               }
           ]
       },
       "label": "Board ID",
       "required": true
   }
]