Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions source/_docs/blueprint/selectors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.
type: list
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 %}

Alternatively, a mapping can be used for the options. When you want to return
Expand Down Expand Up @@ -788,9 +811,13 @@ options:
type: string
{% endconfiguration %}

The output of this selector is the string of the selected option value.
When selecting `Green` in the last example, it returns: `g`, in the first
example it would return `Green`.
When `multiple` is `false`, the output of this selector is the string of
the selected option value. When selecting `Green` in the last example,
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

Expand Down