Checkbox Node
Checkboxes are a common form control that allows the user to check and uncheck a box. Checkboxes are often used for simple yes/no choices, like confirmations.
When checked, the checkbox will trigger the checked event. Conversely, when unchecked, the checkbox will trigger the unchecked event. When disabled, neither of these events will be triggered.
Properties
Visible
Prop | checkboxNode.isVisible |
---|---|
Type | boolean |
Default | {{true}} |
Whether or not this node is visible.
Enabled
Prop | checkboxNode.isEnabled |
---|---|
Type | boolean |
Default | {{true}} |
Whether or not this node is enabled.
Tooltip
Prop | checkboxNode.tooltip |
---|---|
Type | string |
Default | undefined |
The tooltip text to display when hovered or focused over this node.
Top
Prop | checkboxNode.top |
---|---|
Type | string |
Default | 1 |
The position of the node from the top side of the grid (grid-row-start
).
Left
Prop | checkboxNode.left |
---|---|
Type | string |
Default | 1 |
The position of the node from the left side of the grid (grid-column-start
).
Width
Prop | checkboxNode.width |
---|---|
Type | string |
Default | 128px |
The width of the node. When this node is in a grid layout, this should be done using unitless grid column units (specifying 4
will become grid-column-end: span 4
). When this node is in a stack layout, the width must be specified using CSS units (e.g. 100px
or 100%
).
Min Width
Prop | checkboxNode.minWidth |
---|---|
Type | string |
Default | none |
The minimum width of the node. When this node is in a grid layout, this property is ignored.
Max Width
Prop | checkboxNode.maxWidth |
---|---|
Type | string |
Default | none |
The maximum width of the node. When this node is in a grid layout, this property is ignored.
Height
Prop | checkboxNode.height |
---|---|
Type | string |
Default | 32px |
The height of the node. When this node is in a grid layout, this should be done using unitless grid row units (specifying 4
will become grid-row-end: span 4
). When this node is in a stack layout, the height must be specified using CSS units (e.g. 100px
or 100%
).
Min Height
Prop | checkboxNode.minHeight |
---|---|
Type | string |
Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Max Height
Prop | checkboxNode.maxHeight |
---|---|
Type | string |
Default | none |
The minimum height of the node. When this node is in a grid layout, this property is ignored.
Overflow
Prop | checkboxNode.overflow |
---|---|
Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
Default | auto |
The strategy used to handle overflow in the horizontal and vertical axes for content that is larger than its container.
Overflow X
Prop | checkboxNode.overflowX |
---|---|
Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
Default | auto |
The strategy used to handle overflow in the horizontal axis for content that is larger than its container.
Overflow Y
Prop | checkboxNode.overflowY |
---|---|
Type | Overflow ('auto' | 'visible' | 'hidden' | 'scroll') |
Default | auto |
The strategy used to handle overflow in the vertical axis for content that is larger than its container.
Custom Styles
Prop | checkboxNode.styles |
---|---|
Type | string |
Default | element.styles { } |
Custom CSS styles to be applied to the node. Use element.styles
to refer to the current node.
Label
Prop | checkboxNode.label |
---|---|
Type | string |
Default | Check this box? |
The label displayed next to the checkbox.
Field Name
Prop | checkboxNode.formFieldName |
---|---|
Type | string |
Default | undefined |
Defines the key for this input in the body of the submitted form.
Label Style
Prop | checkboxNode.labelStyle |
---|---|
Type | CheckboxLabelStyle ('left' | 'top' | 'hidden' | 'right') |
Default | right |
The display style of the label next to the checkbox.
Size
Prop | checkboxNode.size |
---|---|
Type | CheckboxSize ('sm' | 'md' | 'lg') |
Default | md |
The size of the checkbox. Size is a measurement value like "md" and can be configured in the theme.
Value
Prop | checkboxNode.value |
---|---|
Type | boolean |
Default | {{false}} |
The current value of the checkbox. If checked, this will be true
. If unchecked, this will be false
.
Required
Prop | checkboxNode.isRequired |
---|---|
Type | boolean |
Default | {{false}} |
Whether or not this checkbox must be checked. This is a visual flag that updates the corresponding accessibility properties. It is up to the app developer to enforce the requirement.
Event Handlers
On Checked
Handler | checkboxNode.onChecked |
---|
Called when the checkbox is checked.
On Unchecked
Handler | checkboxNode.onUnchecked |
---|
Called when the checkbox is unchecked.