tdesign-react/es/radio/type.d.ts

TDesign Component for React

/**
 * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
 * */
import { TNode, SizeEnum } from '../common';
import { MouseEvent, ChangeEvent } from 'react';
export interface TdRadioProps<T = RadioValue> {
    /**
     * 是否允许取消选中
     * @default false
     */
    allowUncheck?: boolean;
    /**
     * 是否选中
     * @default false
     */
    checked?: boolean;
    /**
     * 是否选中，非受控属性
     * @default false
     */
    defaultChecked?: boolean;
    /**
     * 单选内容，同 label
     */
    children?: TNode;
    /**
     * 是否为禁用态。如果存在父组件 RadioGroup，默认值由 RadioGroup.disabled 控制。优先级：Radio.disabled > RadioGroup.disabled
     */
    disabled?: boolean;
    /**
     * 主文案
     */
    label?: TNode;
    /**
     * HTML 元素原生属性
     * @default ''
     */
    name?: string;
    /**
     * 只读状态
     * @deprecated It will be removed in the future. Please use `readOnly` instead.
     */
    readonly?: boolean;
    /**
     * 只读状态
     */
    readOnly?: boolean;
    /**
     * 单选按钮的值
     */
    value?: T;
    /**
     * 选中状态变化时触发
     */
    onChange?: (checked: boolean, context: {
        e: ChangeEvent<HTMLDivElement>;
    }) => void;
    /**
     * 点击时触发，一般用于外层阻止冒泡场景
     */
    onClick?: (context: {
        e: MouseEvent<HTMLLabelElement>;
    }) => void;
}
export interface TdRadioGroupProps<T = RadioValue> {
    /**
     * 是否允许取消选中
     * @default false
     */
    allowUncheck?: boolean;
    /**
     * 是否禁用全部子单选框。优先级：Radio.disabled > RadioGroup.disabled
     */
    disabled?: boolean;
    /**
     * HTML 元素原生属性
     * @default ''
     */
    name?: string;
    /**
     * 单选组件按钮形式。RadioOption 数据类型为 string 或 number 时，表示 label 和 value 值相同
     */
    options?: Array<RadioOption>;
    /**
     * 只读状态
     * @deprecated It will be removed in the future. Please use `readOnly` instead.
     */
    readonly?: boolean;
    /**
     * 只读状态
     */
    readOnly?: boolean;
    /**
     * 组件尺寸【讨论中】
     * @default medium
     */
    size?: SizeEnum;
    /**
     * 组件风格
     * @default radio
     */
    theme?: 'radio' | 'button';
    /**
     * 选中的值
     */
    value?: T;
    /**
     * 选中的值，非受控属性
     */
    defaultValue?: T;
    /**
     * 单选组件按钮形式
     * @default outline
     */
    variant?: 'outline' | 'primary-filled' | 'default-filled';
    /**
     * 选中值发生变化时触发, `context.name` 指 RadioGroup 的 name 属性
     */
    onChange?: (value: T, context: {
        e: ChangeEvent<HTMLDivElement>;
        name?: string;
    }) => void;
}
export type RadioOption = string | number | RadioOptionObj;
export interface RadioOptionObj {
    label?: string | TNode;
    value?: string | number | boolean;
    disabled?: boolean;
}
export type RadioValue = string | number | boolean;