Checkbox

A checkbox group — single-pick or multi-pick. Exposes the selection on its value.

Reach for it when you need:

• Multi-select filters
• A multi-choice field inside a Form

Component name: Checkbox · Category: Input

In the palette: Checkbox group — pick one (single) or many (multiple)

Properties

Any property can be bound to a tag, another component's property, or a query.

Property	Type	Default	Description
value	union	""	Single mode → the chosen option (string); multiple mode → the checked options (array).
mode	enum	single	single = pick at most one option; multiple = pick many (value becomes an array). For a lone on/off boolean, use a Switch. Options: single · multiple.
options	array	[{"label":"Option 1","value":"1"},{"label":"Option 2","value… (truncated)	The choices.
↳ options.label	string	New Option	—
↳ options.value	string	""	—
optionsLayout	enum	vertical	Stack the options vertically, or lay them out in a horizontal row. Options: vertical · horizontal.
title	string	Checkbox	—
showTitle	boolean	true	—
titleSize	number	0	Title font size (px). 0 = follows the size. 1.0.8
size	enum	inherit	Field height, padding, text and title size. Project default = the project's Control size (Project settings → Theme). Use md or larger on touch panels. Options: inherit · xs · sm · md · lg · xl. 1.0.8
disabled	boolean	false	—
style	style	{}	Custom CSS properties

Events

Attach event actions to these in the Event Manager.

Event	Label	Group	Payload
click	Click	Mouse	The DOM event.
dblclick	Double click	Mouse	The DOM event.
contextmenu	Right click	Mouse	The DOM event.
mouseenter	Mouse enter	Mouse	The DOM event.
mouseleave	Mouse leave	Mouse	The DOM event.
change	Change	Input	The DOM event.
submit	Submit	Input	The DOM event.
focus	Focus	Input	The DOM event.
blur	Blur	Input	The DOM event.

Right-click behaves differently in the Designer

contextmenu fires your configured actions at runtime only — in LiveView and in preview. On the Designer canvas the right-click is captured to open the Event Manager, so testing it there will not run your actions. Test right-click in preview.

Notes

Size New in 1.0.8

size sets the option labels and the title on one scale shared by every field widget:

size	xs	sm	md	lg	xl
Field height	28 px	36 px	44 px	52 px	64 px
Text	12 px	13 px	14 px	16 px	18 px

The default, Project default (inherit), follows the project's Control size (Project settings → Theme), so one setting resizes every field on every screen. Set size on a widget only where it has to differ. A field, a dropdown and a button at the same size line up exactly, side by side.

titleSize now defaults to 0, which follows the size. A number you set still wins.

Fields, buttons and menus draw smaller after upgrading to 1.0.8

Before 1.0.8 these widgets had one size, what is now md (a 44 px field). The project's Control size defaults to sm (36 px), sized for desktop dashboards, and every widget whose size is Project default follows it — which is every widget in an upgraded project. On a touch panel, set Project settings → Theme → Control size to md or larger: 44 px is the touch-target minimum.