@fayegram-ai/faye-ui/controls/radio-group
Public exports and dependency-resolved component properties, with usage and rendering guidance.
Import
import { RadioGroup } from '@fayegram-ai/faye-ui/controls/radio-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 |
|---|---|---|
RadioGroup | value | { (input: Base.Props<unknown> & { variants?: Readonly<Record<string, string>> | undefined; }): import("react").ReactElement; displayName: string; } |
RadioGroup
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 |
|---|---|---|---|
className | No | string | ((state: RadioGroupState) => string | undefined) | undefined | CSS class applied to the element, or a function that returns a class based on the component's state. |
defaultValue | No | unknown | The uncontrolled value of the radio button that should be initially selected. To render a controlled radio group, use the value prop instead. |
disabled | No | boolean | undefined | Whether the component should ignore user interaction. |
form | No | string | undefined | Identifies the form that owns the radio inputs. Useful when the radio group is rendered outside the form. |
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. |
onValueChange | No | ((value: unknown, eventDetails: Base.ChangeEventDetails) => void) | undefined | Callback fired when the value changes. |
readOnly | No | boolean | undefined | Whether the user should be unable to select a different radio button in the group. |
render | No | ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, RadioGroupState> | 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 choose a value before submitting a form. |
style | No | CSSProperties | ((state: RadioGroupState) => 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 | unknown | The controlled value of the radio item that should be currently selected. To render an uncontrolled radio 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/radio-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.