Stay organized with collectionsSave and categorize content based on your preferences.
A checkbox with a label.
Usage
Returns
ui.Checkbox(label,value,onChange,disabled,style)
ui.Checkbox
Argument
Type
Details
label
String, optional
The checkbox's label. Defaults to an empty string.
value
Boolean, optional
Whether the checkbox is checked. A null value indicates that the checkbox is in an indeterminate state. Defaults to false.
onChange
Function, optional
A callback to fire when the value of the checkbox changes. The callback is passed a boolean indicating whether the checkbox is now checked and the checkbox widget.
disabled
Boolean, optional
Whether the checkbox is disabled. Defaults to false.
style
Object, optional
An object of allowed CSS styles with their values to be set for this widget. See style() documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-10-06 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eui.Checkbox\u003c/code\u003e widget is used to create a checkbox with a label, allowing users to select or deselect an option.\u003c/p\u003e\n"],["\u003cp\u003eIt can be initialized with optional parameters for label, value, onChange callback, disabled state, and custom styles.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonChange\u003c/code\u003e callback is triggered when the checkbox value changes, providing access to the new checked state and the checkbox widget itself.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003evalue\u003c/code\u003e can be set to \u003ccode\u003enull\u003c/code\u003e to represent an indeterminate state, while \u003ccode\u003edisabled\u003c/code\u003e and \u003ccode\u003estyle\u003c/code\u003e parameters offer control over the widget's interactivity and appearance.\u003c/p\u003e\n"]]],["The core content describes a `ui.Checkbox` widget, its usage, and its arguments. It can be created using `ui.Checkbox()` and allows for a `label`, a boolean `value` (checked/unchecked/indeterminate), an `onChange` callback function, a `disabled` state, and custom `style`. The `onChange` callback receives the new boolean state and the widget itself. Each parameter is optional and has default values.\n"],null,["# ui.Checkbox\n\n\u003cbr /\u003e\n\nA checkbox with a label.\n\n\u003cbr /\u003e\n\n| Usage | Returns |\n|--------------------------------------------------------------------------------|-------------|\n| `ui.Checkbox(`*label* `, `*value* `, `*onChange* `, `*disabled* `, `*style*`)` | ui.Checkbox |\n\n| Argument | Type | Details |\n|------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `label` | String, optional | The checkbox's label. Defaults to an empty string. |\n| `value` | Boolean, optional | Whether the checkbox is checked. A null value indicates that the checkbox is in an indeterminate state. Defaults to false. |\n| `onChange` | Function, optional | A callback to fire when the value of the checkbox changes. The callback is passed a boolean indicating whether the checkbox is now checked and the checkbox widget. |\n| `disabled` | Boolean, optional | Whether the checkbox is disabled. Defaults to false. |\n| `style` | Object, optional | An object of allowed CSS styles with their values to be set for this widget. See style() documentation. |"]]
