Checkboxes Fieldtype

Overview

The checkboxes fieldtype is a multiple choice input. It saves one or more options chosen from a preset list. In other words, they're boxes you check.

Configuring

Use the options setting to define a list of values and labels.

favorites:
  type: checkboxes
  instructions: Choose up to 3 favorite foods.
  options:
    donuts: Donuts
    icecream: Ice Cream
    brownies: Brownies

You may omit the labels and just specify keys. If you use this syntax, the value and label will be identical.

options:
  - Donuts
  - Ice Cream
  - Brownies

Data Structure

The values are stored as a YAML array. If you only specified values for the options array, then the labels will be saved.

favorites:
  - donuts
  - icecream

Templating

You can loop through the checked items and access the value and label of each item inside the loop.

<ul>
{{ favorites }}
    <li>{{ value }}</li>
{{ /favorites }}
</ul>

<ul>
    <li>donuts</li>
    <li>icecream</li>
</ul>

Variables

Inside an asset variable's tag pair you'll have access to the following variables.

Options