Update docs for select selector (#22207)

This commit is contained in:
Raman Gupta 2022-03-31 14:03:25 -04:00 committed by Franck Nijhof
parent 7ada3a52b6
commit 33604548e5
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3

View File

@ -755,6 +755,29 @@ options:
List of options that the user can choose from. Small lists (5 items or less), are displayed as radio buttons. When more items are added, a dropdown list is used. List of options that the user can choose from. Small lists (5 items or less), are displayed as radio buttons. When more items are added, a dropdown list is used.
type: list type: list
required: true required: true
multiple:
description: >
Allows selecting multiple options. If set to `true`, the resulting value of
this selector will be a list instead of a single string value.
type: boolean
required: false
default: false
custom_value:
description: >
Allows the user to enter and select a custom value (or multiple custom values
in addition to the listed options if `multiple` is set to `true`).
type: boolean
required: false
default: false
mode:
description: >
This can be either `list` (radio buttons) or `dropdown` (combobox) mode.
When not specified, small lists (5 items or less), are displayed as
radio buttons. When more items are added, a dropdown list is used. If
`custom_value` is `true`, this setting will be ignored and the frontend
will use a `dropdown` input.
type: string
required: false
{% endconfiguration %} {% endconfiguration %}
Alternatively, a mapping can be used for the options. When you want to return Alternatively, a mapping can be used for the options. When you want to return
@ -788,9 +811,13 @@ options:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
The output of this selector is the string of the selected option value. When `multiple` is `false`, the output of this selector is the string of
When selecting `Green` in the last example, it returns: `g`, in the first the selected option value. When selecting `Green` in the last example,
example it would return `Green`. it returns: `g`, in the first example it would return `Green`.
When `multiple` is `true`, the output of this selector is the list of selected
option values. In this case, if `Green` was selected, in the first example it
would return ["Green"] and in the last example it returns ["g"].
## Target selector ## Target selector