API reference
components/icon-checkbox
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/icon-checkbox";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | IconCheckboxProps | Props accepted by IconCheckbox. The full label names the native input. |
| constant | IconCheckbox | An independent icon choice composed from the native Caps Checkbox. |
IconCheckboxPropstype alias
Section titled “IconCheckboxProps”type IconCheckboxProps = object & Omit<CheckboxProps, "children" | "indicator">;Props accepted by IconCheckbox. The full label names the native input.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
label |
string |
- |
icon |
ReactNode |
- |
caption? |
string |
A short visible legend; it does not replace the accessible label. |
appearance? |
"default" | "compact" |
Compact instruments show the icon and caption without a tile or lamp. |
IconCheckboxconstant
Section titled “IconCheckbox”const IconCheckbox: ForwardRefExoticComponent< object & Omit<CheckboxProps, "children" | "indicator"> & RefAttributes<HTMLInputElement>>;An independent icon choice composed from the native Caps Checkbox.