Skip to content

Commit

Permalink
docs: added multiselect type docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Feb 9, 2024
1 parent 4da24e1 commit db07641
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions docs/syntax/types/multiselect.md
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
```

0 comments on commit db07641

Please sign in to comment.