@payfit/unity-components
Version:
23 lines (22 loc) • 1.41 kB
TypeScript
import { RadioGroupProps } from 'react-aria-components/RadioGroup';
export type SelectableCardRadioGroupProps = Omit<RadioGroupProps, 'className' | 'style' | 'isDisabled' | 'isReadOnly'>;
/**
* The `SelectableCardRadioGroup` component renders a group of mutually exclusive selectable card options.
* Use it to display a set of choices where only one selection is allowed.
* @example
* ```tsx
* import { SelectableCardRadioGroup, SelectableCardRadio } from '@payfit/unity-components'
*
* <SelectableCardRadioGroup>
* <SelectableCardRadio value="option1">Option 1</SelectableCardRadio>
* <SelectableCardRadio value="option2">Option 2</SelectableCardRadio>
* <SelectableCardRadio value="option3">Option 3</SelectableCardRadio>
* </SelectableCardRadioGroup>
* ```
* @see {@link SelectableCardRadioGroupProps} for all available props
* @remarks [API Docs](https://unity-components.payfit.io/?path=/docs/inputs-selectablecardgroup-selectablecardradiogroup-docs) • [Design Docs](https://www.payfit.design/24f360409/p/05fc26-selectable-card)
*
* The SelectableCardRadioGroup component adapts to smaller screen sizes, with cards stacking vertically to maintain usability on mobile devices.
*/
declare const SelectableCardRadioGroup: import('react').ForwardRefExoticComponent<SelectableCardRadioGroupProps & import('react').RefAttributes<HTMLDivElement>>;
export { SelectableCardRadioGroup };