2018-01-03 20:14:15 -02:00
|
|
|
---
|
2018-08-14 11:33:13 -06:00
|
|
|
label: "Select"
|
2018-10-01 20:00:57 -04:00
|
|
|
title: select
|
2018-01-03 20:14:15 -02:00
|
|
|
---
|
|
|
|
|
2018-11-29 15:34:04 +01:00
|
|
|
The select widget allows you to pick a string value from a dropdown menu.
|
2018-01-03 20:14:15 -02:00
|
|
|
|
|
|
|
- **Name:** `select`
|
2018-11-29 15:34:04 +01:00
|
|
|
- **UI:** select input
|
|
|
|
- **Data type:** string or array
|
2018-01-03 20:14:15 -02:00
|
|
|
- **Options:**
|
|
|
|
- `default`: accepts a string; defaults to an empty string
|
|
|
|
- `options`: (**required**) a list of options for the dropdown menu; can be listed in two ways:
|
2018-08-14 11:33:13 -06:00
|
|
|
- string values: the label displayed in the dropdown is the value saved in the file
|
|
|
|
- object with `label` and `value` fields: the label displays in the dropdown; the value is saved in the file
|
2018-11-29 15:34:04 +01:00
|
|
|
- `multiple`: accepts a boolean; defaults to `false`
|
2018-01-03 20:14:15 -02:00
|
|
|
- **Example** (options as strings):
|
2018-08-14 07:37:07 -07:00
|
|
|
```yaml
|
2018-08-14 11:33:13 -06:00
|
|
|
- label: "Align Content"
|
|
|
|
name: "align"
|
|
|
|
widget: "select"
|
|
|
|
options: ["left", "center", "right"]
|
2018-08-14 07:37:07 -07:00
|
|
|
```
|
2018-01-03 20:14:15 -02:00
|
|
|
- **Example** (options as objects):
|
2018-08-14 07:37:07 -07:00
|
|
|
```yaml
|
2018-08-14 11:33:13 -06:00
|
|
|
- label: "City"
|
|
|
|
name: "airport-code"
|
|
|
|
widget: "select"
|
2018-08-14 07:37:07 -07:00
|
|
|
options:
|
2018-08-14 11:33:13 -06:00
|
|
|
- { label: "Chicago", value: "ORD" }
|
|
|
|
- { label: "Paris", value: "CDG" }
|
|
|
|
- { label: "Tokyo", value: "HND" }
|
2018-08-14 07:37:07 -07:00
|
|
|
```
|
2018-11-29 15:34:04 +01:00
|
|
|
- **Example** (multiple):
|
|
|
|
```yaml
|
|
|
|
- label: "Tags"
|
|
|
|
name: "tags"
|
|
|
|
widget: "select"
|
|
|
|
multiple: true
|
|
|
|
options: ["Design", "UX", "Dev"]
|
|
|
|
```
|
2018-08-14 11:33:13 -06:00
|
|
|
|