@aveonline/ui-react/dist/ui/atoms/Checkbox/ICheckbox.d.ts

Home base for Aveonline design system - ecosystem react

import { IColorText } from '../../../types';
declare type Change = {
    value: string | number;
    checked: boolean;
};
interface IPropsCheckbox extends IColorText {
    /**
     * ID unique
     */
    id?: string;
    /**
     * Name unique
     */
    name?: string;
    /**
     * Sizes availables - default sm
     */
    size?: 'sm' | 'md';
    /**
     * Control for disabled checkbox
     */
    isDisabled?: boolean;
    /**
     * Value check optional
     */
    value?: string | number;
    /**
     * Label string link with radio
     */
    label?: string;
    /**
     * Help text for more info
     */
    helpText?: string;
    /**
     * Event for control to checked and value
     */
    onChange?: (value: Change) => void;
    /**
     * Validate error
     */
    isError?: boolean;
    /**
     * Option for checked
     */
    checked?: boolean;
}
export type { IPropsCheckbox };