@fayegram-ai/faye-ui/controls/checkbox
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { Checkbox } from '@fayegram-ai/faye-ui/controls/checkbox';Usage and behavior guide · API JSON
This entry declares a client boundary. Follow the rendering guide for framework integration.
Public exports
| Name | Kind | Resolved declaration type |
|---|---|---|
Checkbox | value | { readonly Root: { (input: Omit<import("@base-ui/react").CheckboxRootProps, "ref"> & import("react").RefAttributes<HTMLElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "tone"> | undefined; } | undefined; }): import("react").ReactElement; displayName: string; }; readonly Indicator: { (input: Omit<import("@base-ui/react").CheckboxIndicatorProps, "ref"> & import("react").RefAttributes<HTMLSpanElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-var… (full type in API JSON) |
Checkbox
Public component; use the linked family guide for complete composition and behavior.
Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.
Checkbox.Root
| Property | Required | Type | Meaning |
|---|---|---|---|
checked | No | boolean | undefined | Whether the checkbox is currently ticked. To render an uncontrolled checkbox, use the defaultChecked prop instead. |
className | No | string | ((state: CheckboxRootState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
defaultChecked | No | boolean | undefined | Whether the checkbox is initially ticked. To render a controlled checkbox, use the checked prop instead. |
disabled | No | boolean | undefined | Whether the component should ignore user interaction. |
form | No | string | undefined | Identifies the form that owns the hidden input. Useful when the checkbox is rendered outside the form. |
id | No | string | undefined | The id of the input element. |
indeterminate | No | boolean | undefined | Whether the checkbox is in a mixed state: neither ticked, nor unticked. |
inputRef | No | Ref<HTMLInputElement> | undefined | A ref to access the hidden <input> element. |
name | No | string | undefined | Identifies the field when a form is submitted. |
nativeButton | No | boolean | undefined | Whether the component renders a native <button> element when replacing it via the render prop. Set to true if the rendered element is a native button. |
onCheckedChange | No | ((checked: boolean, eventDetails: CheckboxRootChangeEventDetails) => void) | undefined | Event handler called when the checkbox is ticked or unticked. |
parent | No | boolean | undefined | Whether the checkbox controls a group of child checkboxes. Must be used in a Checkbox Group. |
readOnly | No | boolean | undefined | Whether the user should be unable to tick or untick the checkbox. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, CheckboxRootState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
required | No | boolean | undefined | Whether the user must tick the checkbox before submitting a form. |
style | No | CSSProperties | ((state: CheckboxRootState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
uncheckedValue | No | string | undefined | The value submitted with the form when the checkbox is unchecked. By default, unchecked checkboxes do not submit any value, matching native checkbox behavior. |
value | No | string | undefined | The checkbox's value. Identifies it within a Checkbox Group, falling back to name when omitted. When submitting a form, a checked box submits value; with no value, it submits the native "on". |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Checkbox.Indicator
| Property | Required | Type | Meaning |
|---|---|---|---|
className | No | string | ((state: CheckboxIndicatorState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
keepMounted | No | boolean | undefined | Whether to keep the element in the DOM when the checkbox is not checked. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, CheckboxIndicatorState> | undefined | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a ReactElement or a function that returns the element to render. |
style | No | CSSProperties | ((state: CheckboxIndicatorState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
variants | No | { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "size"> | undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"checkbox", "tone"> | undefined; } | undefined | See the usage contract and declaration. |
Defaults and customization
Descriptor defaults: {"size":"md","tone":"neutral"}. Parts: root, indicator. Explicit instance props take precedence over configured defaults.
Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.
State, events and accessibility
For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.
Declaration authority
Generated from packages/faye-ui/dist/controls/checkbox.d.ts after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. React DOM attributes and Base UI component contracts describe the inherited foundations.