Boolean and select

booleanCopy Anchor Link

True or false: dog friendly, step-free, featured. Held once for every locale.

fields:
  - { name: dogFriendly, type: boolean, index: true, label: { en-GB: Dogs welcome } }

A boolean has no parameters of its own, and an unset boolean is false in a template. It has no validation of its own, and required on a boolean does not force it to be true: use a validation rule (agreed == true) for that.

The stored value is a JSON true or false, and a template receives the boolean:

{% if entry.dogFriendly %}<p>Dogs welcome</p>{% endif %}

A boolean cannot be unique. In an expression it is compared with true or false: dogFriendly == true.

selectCopy Anchor Link

One value, or several with multiple: true, from a list the schema declares.

fields:
  - name: difficulty
    type: select
    required: true
    index: true
    options:
      - { value: easy, label: { en-GB: Easy, cy-GB: Hawdd } }
      - { value: moderate, label: { en-GB: Moderate, cy-GB: Cymedrol } }
      - { value: hard, label: { en-GB: Hard, cy-GB: Anodd } }
  - name: facilities
    type: select
    multiple: true
    index: true
    options:
      - { value: parking, label: { en-GB: Parking } }
      - { value: wifi, label: { en-GB: Wi-Fi } }
      - { value: stepFree, label: { en-GB: Step-free access } }

ParametersCopy Anchor Link

Give every option a label as a locale map. A template’s label reads the label for the request locale from the map, and falls back to the value when there is none.

engine-dmo check warns when an option’s label map lacks an enabled locale (the label of option hard has no translation for cy), but says nothing about an option with no label at all, or one whose label is a plain string. A plain-string label passes check, but a template’s .label prints the value instead. engine-dmo dev field add --options a,b,c writes options with no labels; add label: { en: ... } to each, keeping its id:.

ValidationCopy Anchor Link

An expression that compares a select with a value it does not offer fails engine-dmo check with the options listed: visible_when: "tlak" is not an option of kind.

Stored valueCopy Anchor Link

Seed files, imports, the content API and templates use the option’s value: a string, or a list of strings with multiple. Internally the engine stores the option’s id, so renaming a value (keeping its id) keeps every document’s choice, and the schema plan shows it as a rename. Removing an option that documents hold is a destructive change (Schema changes).

Template valueCopy Anchor Link

A single select is an option with value and label, or nothing when empty. A multiple select is a list of them, in the order chosen.

<dd class="difficulty-{{ entry.difficulty.value }}">{{ entry.difficulty.label }}</dd>

{% if entry.facilities %}
<ul>{% for f in entry.facilities %}<li>{{ f.label }}</li>{% endfor %}</ul>
{% endif %}

engine-dmo dev option add <type> <field> <value> adds an option with its id. A select reads an old text value exactly when it is one of the options; a value that is not is kept and flagged for a person to decide.