@payfit/unity-components
Version:
23 lines (22 loc) • 1.07 kB
TypeScript
import { RadioGroupProps } from 'react-aria-components/RadioGroup';
/**
* Props for the RadioButtonGroup component.
* Excludes className and style props as they are handled internally.
*/
export type RadioButtonGroupProps = Omit<RadioGroupProps, 'className' | 'style'>;
/**
* The `RadioButtonGroup` component enables users to select a single option from a set of mutually exclusive choices.
* It manages the selection state, keyboard navigation, focus handling, and accessibility features for a group of RadioButton components.
* @example
* ```tsx
* import { RadioButton, RadioButtonGroup } from '@payfit/unity-components'
*
* <RadioButtonGroup value="option1" onChange={setValue}>
* <RadioButton value="option1">Option 1</RadioButton>
* <RadioButton value="option2">Option 2</RadioButton>
* <RadioButton value="option3">Option 3</RadioButton>
* </RadioButtonGroup>
* ```
*/
declare const RadioButtonGroup: import('react').ForwardRefExoticComponent<RadioButtonGroupProps & import('react').RefAttributes<HTMLDivElement>>;
export { RadioButtonGroup };