@cerberus-design/react
Version:
The Cerberus Design React component library.
36 lines (35 loc) • 3.27 kB
TypeScript
import { RadioGroup as ArkRadioGroup, RadioGroupIndicatorProps as ArkRadioGroupIndicatorProps, RadioGroupItemControlProps as ArkRadioGroupItemControlProps, RadioGroupItemHiddenInputProps as ArkRadioGroupItemHiddenInputProps, RadioGroupItemProps as ArkRadioGroupItemProps, RadioGroupItemTextProps as ArkRadioGroupItemTextProps, RadioGroupLabelProps as ArkRadioGroupLabelProps, RadioGroupRootProps as ArkRadioGroupRootProps } from '@ark-ui/react/radio-group';
import { RadioGroupVariantProps } from 'styled-system/recipes';
import { CerberusPrimitiveProps } from '../../system/index';
import { ForwardRefExoticComponent, RefAttributes } from 'react';
export type RadioGroupRootProps = CerberusPrimitiveProps<ArkRadioGroupRootProps & RadioGroupVariantProps>;
export declare const RadioGroupRoot: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.RootProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupLabelProps = CerberusPrimitiveProps<ArkRadioGroupLabelProps>;
export declare const RadioGroupLabel: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.LabelProps & RefAttributes<HTMLLabelElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupIndicatorProps = CerberusPrimitiveProps<ArkRadioGroupIndicatorProps>;
export declare const RadioGroupIndicator: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.IndicatorProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupItemProps = CerberusPrimitiveProps<ArkRadioGroupItemProps>;
export declare const RadioGroupItem: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.ItemProps & RefAttributes<HTMLLabelElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupItemTextProps = CerberusPrimitiveProps<ArkRadioGroupItemTextProps & RadioGroupVariantProps>;
export declare const RadioGroupItemText: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.ItemTextProps & RefAttributes<HTMLSpanElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupItemControlProps = CerberusPrimitiveProps<ArkRadioGroupItemControlProps & RadioGroupVariantProps>;
export declare const RadioGroupItemControl: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.ItemControlProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;
export type RadioGroupItemHiddenInputProps = ArkRadioGroupItemHiddenInputProps;
export declare const RadioGroupItemHiddenInput: ForwardRefExoticComponent<ArkRadioGroup.ItemHiddenInputProps & RefAttributes<HTMLInputElement>>;
/**
* The context provider for a set of radio buttons.
* It provides the necessary context for managing the state of the radio group.
* @see {@link https://cerberus.digitalu.design/react/radio/overview}
*
* @example
* ```tsx
* import { RadioGroup } from '@cerberus/react/radio';
*
* <RadioGroup defaultValue="cerberus">
* <Radio value="cerberus">Cerberus</Radio>
* <Radio value="hades">Hades</Radio>
* <Radio value="zeus">Zeus</Radio>
* </RadioGroup>
* ```
*/
export declare const RadioGroup: ForwardRefExoticComponent<Omit<CerberusPrimitiveProps<ArkRadioGroup.RootProps & RefAttributes<HTMLDivElement>>, "ref"> & RefAttributes<unknown>>;