@payfit/unity-components
Version:
21 lines (20 loc) • 1.27 kB
TypeScript
import { CheckboxGroupProps as AriaCheckboxGroupProps } from 'react-aria-components/CheckboxGroup';
export type SelectableCardCheckboxGroupProps = AriaCheckboxGroupProps;
/**
* The `SelectableCardCheckboxGroup` component renders a group of selectable card checkboxes.
* Use it to display a set of options where multiple selections are allowed.
* @example
* ```tsx
* import { SelectableCardCheckboxGroup, SelectableCardCheckbox } from '@payfit/unity-components'
*
* <SelectableCardCheckboxGroup>
* <SelectableCardCheckbox value="option1">Option 1</SelectableCardCheckbox>
* <SelectableCardCheckbox value="option2">Option 2</SelectableCardCheckbox>
* <SelectableCardCheckbox value="option3">Option 3</SelectableCardCheckbox>
* </SelectableCardCheckboxGroup>
* ```
* @see {@link SelectableCardCheckboxGroupProps} for all available props
* @remarks [API Docs](https://unity-components.payfit.io/?path=/docs/inputs-selectablecardgroup-selectablecardcheckboxgroup--docs) • [Design Docs](https://www.payfit.design/24f360409/p/05fc26-selectable-card)
*/
declare const SelectableCardCheckboxGroup: import('react').ForwardRefExoticComponent<AriaCheckboxGroupProps & import('react').RefAttributes<HTMLDivElement>>;
export { SelectableCardCheckboxGroup };