Skip to content

Commit

Permalink
docs: added select type docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarvinJWendt committed Feb 9, 2024
1 parent 9efcf3e commit 4da24e1
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/syntax/types/select.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Select

The `select` type can be used to define variables that accept a single option from a list of predefined options.

## Basic

Basic syntax for the `select` type:

```yaml
variables:
- name: Color
type: select # Set the type to select
options: # Define the options
- name: Red
- name: Green
- name: Blue
description: Favorite color
template: |-
Your favorite color is {{ .Color }}.
```
## Custom values
You can use the `value` property to define custom values for the options:

```yaml
variables:
- name: Color
type: select
options:
- name: Red
value: "#ff0000" # Set the value to a hex color code
- name: Green
value: "#00ff00"
- name: Blue
value: "#0000ff"
description: Favorite color
template: |-
Your favorite color is {{ .Color }}.
```

0 comments on commit 4da24e1

Please sign in to comment.