Field checkbox

Version: Free.

Why this type

One checkbox for one option. The saved value is yes or no, not the string "1" or "0". With showWhen it shows or hides other fields.

When to use

• "Show button", "Open in new tab"
• Enable block or overlay flag
• showWhen trigger for dependent fields

Tips

Multiple independent flags use checkboxgroup. Visible on/off switch fits toggle better.

Similar types

• toggle for switch UI
• yesno for classic MODX yes/no

Schema

{
  "name": "featured",
  "type": "checkbox",
  "label": "Featured",
  "tab": "Content",
  "width": 100,
  "active": true
}

Value

Boolean.

Section data

Key featured in the section data:

{
  "featured": true
}

Chunk example

modx

<span class="badge">Featured</span>

fenom

{if $featured}<span class="badge">Featured</span>{/if}

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