@fayegram-ai/faye-ui/controls/checkbox-group
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { CheckboxGroup } from '@fayegram-ai/faye-ui/controls/checkbox-group';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 |
|---|---|---|
CheckboxGroup | value | { (input: Omit<import("@base-ui/react").CheckboxGroupProps, "ref"> & import("react").RefAttributes<HTMLDivElement> & { variants?: Readonly<Record<string, string>> | undefined; }): import("react").ReactElement; displayName: string; } |
CheckboxGroup
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.
Properties
| Property | Required | Type | Meaning |
|---|---|---|---|
allValues | No | string[] | undefined | Names of all checkboxes in the group. Use this when creating a parent checkbox. |
className | No | string | ((state: CheckboxGroupState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
defaultValue | No | string[] | undefined | Names of the checkboxes in the group that should be initially ticked. To render a controlled checkbox group, use the value prop instead. |
disabled | No | boolean | undefined | Whether the component should ignore user interaction. |
onValueChange | No | ((value: string[], eventDetails: CheckboxGroupChangeEventDetails) => void) | undefined | Event handler called when a checkbox in the group is ticked or unticked. Provides the new value as an argument. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, CheckboxGroupState> | 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: CheckboxGroupState) => React.CSSProperties | undefined) | undefined | Style applied to the element, or a function that returns a style object based on the component's state. |
value | No | string[] | undefined | Names of the checkboxes in the group that should be ticked. To render an uncontrolled checkbox group, use the defaultValue prop instead. |
variants | No | Readonly<Record<string, string>> | undefined | See the usage contract and declaration. |
Defaults and customization
Defaults and native behavior are documented in the linked family guide. This reference does not infer a default from an optional property.
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-group.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.