Field checkboxgroup

Version: Free.

Why this type

Multiple picks from one options list. Data is an array of value strings, not objects. Alternative to multiselect for short lists without search.

When to use

• Filter tags, icon set, feature flags
• "Which columns to show" from a fixed set
• Multi pick without multiselect

Tips

A single flag fits checkbox. Long searchable lists need multiselect.

Similar types

• multiselect for PrimeVue multi with filter
• tag for free-form strings (Pro)

Schema

{
  "name": "tags",
  "type": "checkboxgroup",
  "label": "Tags",
  "options": [
    {
      "label": "New",
      "value": "new"
    },
    {
      "label": "Bestseller",
      "value": "hit"
    }
  ],
  "tab": "Content",
  "width": 100,
  "active": true
}

Value

Array of strings (value of checked options).

Section data

Key tags in the section data: array of checked option values:

{
  "tags": [
    "new",
    "hit"
  ]
}

Chunk example

{foreach $tags as $tag}
  <span class="tag">{$tag|escape}</span>
{/foreach}

Notes

Options from options or optionsSource, same as select.

Common properties

For fields with name that are stored in the section data:

Key	Type	Role	CMP
tab	string	Group subtitle in the inspector	yes
width	25–100	Field width as % of the row (flex)	yes
description	string	Hint under the label	yes
default	any	Initial value for a new section	yes
active	bool	false hides the field in the inspector	yes
required	bool	Required on publish (draft still saves)	yes

See fields overview.

See also

• Field types reference
• Fields overview