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. |
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 | 13 | — |
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.