@payfit/unity-components
Version:
27 lines (26 loc) • 1.24 kB
TypeScript
import { SelectableCardCheckboxGroupProps } from './SelectableCardCheckboxGroup.js';
export type TanstackSelectableCardCheckboxGroupProps = Omit<SelectableCardCheckboxGroupProps, 'value' | 'defaultValue' | 'isInvalid'>;
/**
* `TanstackSelectableCardCheckboxGroup` is a controlled checkbox group wired to the TanStack Form field context. It is based on the Unity `SelectableCardCheckboxGroup` component.
* @example
* ```tsx
* import { useTanstackUnityForm } from '@payfit/unity-components'
* function ExampleField() {
* const form = useTanstackUnityForm({ validators: {} })
* return (
* <form.Form>
* <form.AppField name="options">
* {(field) => (
* <field.SelectableCardCheckboxGroup>
* <SelectableCardCheckbox value="option1" title="Option 1" />
* <SelectableCardCheckbox value="option2" title="Option 2" />
* </field.SelectableCardCheckboxGroup>
* )}
* </form.AppField>
* </form.Form>
* )
* }
* ```
*/
declare const TanstackSelectableCardCheckboxGroup: import('react').ForwardRefExoticComponent<TanstackSelectableCardCheckboxGroupProps & import('react').RefAttributes<HTMLDivElement>>;
export { TanstackSelectableCardCheckboxGroup };