Checkbox
The Checkbox
is similar to the Switch component, offering the user to make a "Yes or No" decision, but using a checkbox as the UI element instead of a toggle.
Properties
The Checkbox
component offers the following configuration properties.
Events
The Checkbox
offers three events related to changing its state. All of these events will only fire when the state changes due to UI events (i.e. user clicks), not when the checkbox state is changed programmatically. None of the associated actions will receive any arguments when triggered.
On change run: This action is triggered every time the checkbox value changes.
On false run: This action is triggered when the checkbox value changes from
true
tofalse
, i.e. when the user unchecks it.On true run: This action is triggered when the checkbox value changes from
false
totrue
, i.e. when the user checks it.
"On false run" and "On true run" are triggered slightly earlier than "On change". They are however not executed in sequence, i.e. triggering the "On change" action does not wait or depend on the execution of "On false" or "On true". Due to this behavior, their executions might overlap.
API
The Checkbox
exposes the following API in the JavaScript runtime environment.
Last updated