Skip to main content

Checkbox

Rocket 2.0

The Checkbox component lets the user turn a single option on or off, such as agreeing to terms or marking a task as done. When it is mandatory, the user must check it.

Properties​

Property
Description
Expected Value
LabelText shown next to the checkbox.Text. Default: Checkbox
Help textHelp text shown under the label.Text
Checked by defaultWhether the checkbox starts checked. Changing it resets the checkbox to this state.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off
Dynamic heightLets the component grow with its content in the running app instead of keeping a fixed height.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On changeTriggers when the checkbox is checked or unchecked.
On checkTriggers when the checkbox becomes checked.
On un checkTriggers when the checkbox becomes unchecked.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
ToggleSwitches the checkbox between checked and unchecked.components.checkbox1.toggle()
Set valueChecks or unchecks the checkbox, based on Value.components.checkbox1.setValue(true)
Set visibilityShows the component when true, hides it when false.components.checkbox1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.checkbox1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.checkbox1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
labelText shown next to the checkbox.{{components.checkbox1.label}}
descriptionHelp text shown under the label.{{components.checkbox1.description}}
defaultCheckedWhether the checkbox starts checked. Changing it resets the checkbox to this state.{{components.checkbox1.defaultChecked}}
valuetrue when the checkbox is checked, false when it is not.{{components.checkbox1.value}}
isVisibleWhether the component is visible.{{components.checkbox1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.checkbox1.isLoading}}
isDisabledWhether the component is disabled.{{components.checkbox1.isDisabled}}

Styles​

Style
Default
Checked colorTheme: Brand primary
Label colorTheme: Primary text
Help text colorTheme: Placeholder text
Unchecked box border colorTheme: Brand primary
Error colorTheme: Error
Label color (earlier name)—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.