UI: Checkbox
A checkbox with its label. Import the token file once (@pithyx/ui/tokens.css) and wrap the app in UiProvider; see @pithyx/ui.
Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.
Interfaces
Section titled “Interfaces”CheckboxProps
Section titled “CheckboxProps”The props of Checkbox: React Aria’s checkbox field props plus the label.
Extends
Section titled “Extends”Omit<CheckboxFieldProps,"className"|"children">
Properties
Section titled “Properties”children
Section titled “children”children: ReactNode;The label, also the accessible name.
Functions
Section titled “Functions”Checkbox()
Section titled “Checkbox()”function Checkbox(props): Element;A checkbox with its label.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
props |
CheckboxProps |
React Aria’s checkbox field props (isSelected, onChange, isDisabled) plus the label. |
Returns
Section titled “Returns”Element
The checkbox with its label.