API reference
components/checkbox
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/checkbox";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | CheckboxProps | Props accepted by Checkbox. |
| constant | Checkbox | A native checkbox with styled invalid-state presentation. |
CheckboxPropstype alias
Section titled “CheckboxProps”type CheckboxProps = object & InputHTMLAttributes<HTMLInputElement>;Props accepted by Checkbox.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
appearance? |
"default" | "compact" |
Compact instruments keep the wrapper’s focus ring and disabled ink readable. |
indicator? |
ReactNode |
Replaces the bead while the native input continues to own selection. |
invalid? |
boolean |
- |
indeterminate? |
boolean |
Shows a mixed selection while checked still controls native form submission. |
Checkboxconstant
Section titled “Checkbox”const Checkbox: ForwardRefExoticComponent< object & InputHTMLAttributes<HTMLInputElement> & RefAttributes<HTMLInputElement>>;A native checkbox with styled invalid-state presentation.