@nex-ui/react/dist/types/components/radioGroup/types.d.ts

🎉 A beautiful, modern, and reliable React component library.

import { ElementType, ReactNode } from 'react';
import { ClassValue } from 'clsx';
import { Interpolation } from '@nex-ui/system';
import { OverrideProps, ComponentSlotClasses, ComponentPropsWithCommonProps } from '../../types/utils.js';
import { RadioVariants, RadioGroupVariants } from '../../theme/recipes/radioGroup.js';

type RadioSlotProps = {
    root?: ComponentPropsWithCommonProps<'label'>;
    dot?: ComponentPropsWithCommonProps<'span'>;
    label?: ComponentPropsWithCommonProps<'span'>;
};
type RadioOwnProps<RadioComponent extends ElementType = 'input'> = {
    /**
     * The component or element to render as the input.
     *
     * @default 'input'
     */
    as?: RadioComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The label of the Radio.
     */
    children?: ReactNode;
    /**
     * If true, the Radio is disabled.
     *
     * @default false
     */
    disabled?: boolean;
    /**
     * The value of the Radio.
     */
    value?: string | number;
    /**
     * If true, the Radio is checked. (controlled)
     */
    checked?: boolean;
    /**
     * If true, the Radio is checked by default. (uncontrolled)
     */
    defaultChecked?: boolean;
    /**
     * Handler that is called when the element's checked state changes.
     */
    onCheckedChange?: (checked: boolean) => void;
    /**
     * The size of the Radio.
     *
     * @default 'md'
     */
    size?: RadioVariants['size'];
    /**
     * The color of the Radio.
     *
     * @default primaryThemeColor
     */
    color?: RadioVariants['color'];
    /**
     * The className used for each slot.
     */
    classNames?: ComponentSlotClasses<keyof RadioSlotProps>;
    /**
     * The props used for each slot.
     */
    slotProps?: RadioSlotProps;
};
interface RadioPropsOverrides {
}
type RadioProps<RadioComponent extends ElementType = 'input'> = OverrideProps<RadioComponent, RadioOwnProps<RadioComponent>, RadioPropsOverrides>;
type RadioGroupSlotProps = {
    label?: ComponentPropsWithCommonProps<'h3'>;
    wrapper?: ComponentPropsWithCommonProps<'div'>;
};
type RadioGroupOwnProps<T extends string | number, RootComponent extends ElementType> = {
    /**
     * The component or element to render as the root.
     *
     * @default 'div'
     */
    as?: RootComponent;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: Interpolation;
    /**
     * Additional class names to apply to the root.
     */
    className?: ClassValue;
    /**
     * The props used for each slot.
     */
    slotProps?: RadioGroupSlotProps;
    /**
     * The className used for each slot.
     */
    classNames?: ComponentSlotClasses<'label' | 'wrapper'>;
    /**
     * If true, all radios are disabled.
     *
     * @default false
     */
    disabled?: boolean;
    /**
     * The name of the RadioGroup, used when submitting an HTML form.
     */
    name?: string;
    /**
     * The current selected value. (controlled)
     */
    value?: T;
    /**
     * The default selected value. (uncontrolled)
     */
    defaultValue?: T;
    /**
     * Handler that is called when the value changes.
     */
    onValueChange?: (value: T) => void;
    /**
     * The size of all radios.
     */
    size?: RadioVariants['size'];
    /**
     * The color of all radios.
     */
    color?: RadioVariants['color'];
    /**
     * The orientation of the RadioGroup.
     *
     * @default 'horizontal'
     */
    orientation?: RadioGroupVariants['orientation'];
    /**
     * The label of the RadioGroup.
     */
    label?: ReactNode;
};
interface RadioGroupPropsOverrides {
}
type RadioGroupProps<T extends string | number = string | number, RootComponent extends ElementType = 'div'> = OverrideProps<RootComponent, RadioGroupOwnProps<T, RootComponent>, RadioGroupPropsOverrides>;

export type { RadioGroupProps, RadioGroupPropsOverrides, RadioProps, RadioPropsOverrides };