-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4da24e1
commit db07641
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# Multiselect | ||
|
||
The `multiselect` type can be used to define variables that accept multiple options from a list of predefined options. | ||
|
||
## Basic | ||
|
||
Basic syntax for the `multiselect` type: | ||
|
||
```yaml | ||
variables: | ||
- name: Colors | ||
type: multiselect # Set the type to multiselect | ||
options: # Define the options | ||
- name: Red | ||
- name: Green | ||
- name: Blue | ||
description: Favorite colors | ||
template: |- | ||
Your favorite colors are {{ .Colors }}. | ||
``` | ||
## Custom values | ||
You can use the `value` property to define custom values for the options: | ||
|
||
```yaml | ||
variables: | ||
- name: Colors | ||
type: multiselect | ||
options: | ||
- name: Red | ||
value: "#ff0000" # Set the value to a hex color code | ||
- name: Green | ||
value: "#00ff00" | ||
- name: Blue | ||
value: "#0000ff" | ||
description: Favorite colors | ||
template: |- | ||
Your favorite colors are {{ .Colors }}. | ||
``` | ||
|
||
## Iterate over results | ||
|
||
You can use the `range` function in the template to iterate over the results: | ||
|
||
```yaml | ||
variables: | ||
- name: Colors | ||
type: multiselect | ||
options: | ||
- name: Red | ||
- name: Green | ||
- name: Blue | ||
description: Favorite colors | ||
template: |- | ||
Your favorite colors are: | ||
{{- range .Colors }} | ||
- {{ . }} | ||
{{- end }} | ||
``` | ||
|
||
When every color is selected, the output will be: | ||
|
||
``` | ||
Your favorite colors are: | ||
- Red | ||
- Green | ||
- Blue | ||
``` |