element-plus/lib/components/checkbox/src/checkbox.d.ts

A Component Library for Vue 3

import { AriaProps } from 'element-plus/es/hooks';
import type { ExtractPublicPropTypes } from 'vue';
import type { ComponentSize } from 'element-plus/es/constants';
import type Checkbox from './checkbox.vue';
export type CheckboxValueType = string | number | boolean;
export interface CheckboxProps extends Pick<AriaProps, 'ariaLabel' | 'ariaControls'> {
    /**
     * @description binding value
     */
    modelValue?: number | string | boolean;
    /**
     * @description label of the Checkbox when used inside a `checkbox-group`
     */
    label?: string | boolean | number | object;
    /**
     * @description value of the Checkbox when used inside a `checkbox-group`
     */
    value?: string | boolean | number | object;
    /**
     * @description Set indeterminate state, only responsible for style control
     */
    indeterminate?: boolean;
    /**
     * @description whether the Checkbox is disabled
     */
    disabled?: boolean;
    /**
     * @description if the Checkbox is checked
     */
    checked?: boolean;
    /**
     * @description native 'name' attribute
     */
    name?: string;
    /**
     * @description value of the Checkbox if it's checked
     */
    trueValue?: string | number;
    /**
     * @description value of the Checkbox if it's not checked
     */
    falseValue?: string | number;
    /**
     * @deprecated use `trueValue` instead
     * @description value of the Checkbox if it's checked
     */
    trueLabel?: string | number;
    /**
     * @deprecated use `falseValue` instead
     * @description value of the Checkbox if it's not checked
     */
    falseLabel?: string | number;
    /**
     * @description input id
     */
    id?: string;
    /**
     * @description whether to add a border around Checkbox
     */
    border?: boolean;
    /**
     * @description size of the Checkbox
     */
    size?: ComponentSize;
    /**
     * @description input tabindex
     */
    tabindex?: string | number;
    /**
     * @description whether to trigger form validation
     */
    validateEvent?: boolean;
}
/**
 * @deprecated Removed after 3.0.0, Use `CheckboxProps` instead.
 */
export declare const checkboxProps: {
    ariaControls: StringConstructor;
    /**
     * @description binding value
     */
    modelValue: {
        type: (NumberConstructor | StringConstructor | BooleanConstructor)[];
        default: undefined;
    };
    /**
     * @description label of the Checkbox when used inside a `checkbox-group`
     */
    label: {
        type: (ObjectConstructor | NumberConstructor | StringConstructor | BooleanConstructor)[];
        default: undefined;
    };
    /**
     * @description value of the Checkbox when used inside a `checkbox-group`
     */
    value: {
        type: (ObjectConstructor | NumberConstructor | StringConstructor | BooleanConstructor)[];
        default: undefined;
    };
    /**
     * @description Set indeterminate state, only responsible for style control
     */
    indeterminate: BooleanConstructor;
    /**
     * @description whether the Checkbox is disabled
     */
    disabled: {
        type: BooleanConstructor;
        default: undefined;
    };
    /**
     * @description if the Checkbox is checked
     */
    checked: BooleanConstructor;
    /**
     * @description native 'name' attribute
     */
    name: {
        type: StringConstructor;
        default: undefined;
    };
    /**
     * @description value of the Checkbox if it's checked
     */
    trueValue: {
        type: (NumberConstructor | StringConstructor)[];
        default: undefined;
    };
    /**
     * @description value of the Checkbox if it's not checked
     */
    falseValue: {
        type: (NumberConstructor | StringConstructor)[];
        default: undefined;
    };
    /**
     * @deprecated use `trueValue` instead
     * @description value of the Checkbox if it's checked
     */
    trueLabel: {
        type: (NumberConstructor | StringConstructor)[];
        default: undefined;
    };
    /**
     * @deprecated use `falseValue` instead
     * @description value of the Checkbox if it's not checked
     */
    falseLabel: {
        type: (NumberConstructor | StringConstructor)[];
        default: undefined;
    };
    /**
     * @description input id
     */
    id: {
        type: StringConstructor;
        default: undefined;
    };
    /**
     * @description whether to add a border around Checkbox
     */
    border: BooleanConstructor;
    /**
     * @description size of the Checkbox
     */
    size: {
        readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<StringConstructor, "" | "small" | "default" | "large", never>>;
        readonly required: false;
        readonly validator: ((val: unknown) => boolean) | undefined;
        __epPropKey: true;
    };
    /**
     * @description input tabindex
     */
    tabindex: (NumberConstructor | StringConstructor)[];
    /**
     * @description whether to trigger form validation
     */
    validateEvent: {
        type: BooleanConstructor;
        default: boolean;
    };
    ariaLabel: StringConstructor;
};
export declare const checkboxEmits: {
    "update:modelValue": (val: CheckboxValueType) => val is string | number | boolean;
    change: (val: CheckboxValueType) => val is string | number | boolean;
};
/**
 * @deprecated Removed after 3.0.0, Use `CheckboxProps` instead.
 */
export type CheckboxPropsPublic = ExtractPublicPropTypes<typeof checkboxProps>;
export type CheckboxEmits = typeof checkboxEmits;
export type CheckboxInstance = InstanceType<typeof Checkbox> & unknown;
export declare const checkboxPropsDefaults: {
    readonly modelValue: undefined;
    readonly label: undefined;
    readonly value: undefined;
    readonly disabled: undefined;
    readonly name: undefined;
    readonly trueValue: undefined;
    readonly falseValue: undefined;
    readonly trueLabel: undefined;
    readonly falseLabel: undefined;
    readonly id: undefined;
    readonly validateEvent: true;
};