Skip to main content
Version: Next

Checkbox

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

The Checkbox component as it renders with its default settings.The Checkbox component as it renders with its default settings.

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.

PropertyTypeDefaultDescription
valueunion""Single mode → the chosen option (string); multiple mode → the checked options (array).
modeenumsinglesingle = pick at most one option; multiple = pick many (value becomes an array). For a lone on/off boolean, use a Switch. Options: single · multiple.
optionsarray[{"label":"Option 1","value":"1"},{"label":"Option 2","value… (truncated)The choices.
optionsLayoutenumverticalStack the options vertically, or lay them out in a horizontal row. Options: vertical · horizontal.
titlestringCheckbox
showTitlebooleantrue
titleSizenumber13
disabledbooleanfalse
stylestyle{}Custom CSS properties

Events

Attach event actions to these in the Event Manager.

EventLabelGroupPayload
clickClickMouseThe DOM event.
dblclickDouble clickMouseThe DOM event.
contextmenuRight clickMouseThe DOM event.
mouseenterMouse enterMouseThe DOM event.
mouseleaveMouse leaveMouseThe DOM event.
changeChangeInputThe DOM event.
submitSubmitInputThe DOM event.
focusFocusInputThe DOM event.
blurBlurInputThe 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.