@ownclouders/design-system/dist/src/components/OcCheckbox/OcCheckbox.vue.d.ts

ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components

import { PropType } from 'vue';
/**
 * A checkbox input element. The checkbox is either checked or unchecked.
 */
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
    /**
     * Id for the checkbox. If it's empty, a generated one will be used.
     */
    id: {
        type: StringConstructor;
        required: false;
        default: () => string;
    };
    /**
     * Disables the checkbox
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The model of the checkbox. It determines, based on the option this checkbox represents, whether or not this
     * checkbox is checked. Provide it as value or bind it with v-model.
     *
     * Can be any type, but most common is boolean for singular checkbox use, or array when used in a group of checkboxes.
     **/
    modelValue: {
        type: PropType<boolean | unknown[]>;
        required: false;
        default: boolean;
    };
    /**
     * The value/object this checkbox represents.
     *
     * Can be of any type. If `value` is an array, the type of the option needs to match the value item types. If the
     * checkbox is used standalone (not in a group on a shared model) the option can be omitted.
     **/
    option: {
        required: false;
        default: any;
    };
    /**
     * Label of the Checkbox
     *
     * Always required for aria-label property. If you want to hide the label, use `hideLabel` property.
     **/
    label: {
        type: StringConstructor;
        required: true;
        default: any;
    };
    /**
     * Hide the label of the Checkbox
     */
    labelHidden: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Size of the Checkbox. Valid values are `small`, `medium` and `large`.
     * If not specified, defaults to `medium`
     */
    size: {
        type: StringConstructor;
        required: false;
        default: string;
        validator: (size: string) => boolean;
    };
    /**
     * Show outline of checkbox
     **/
    outline: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
}>, {}, {}, {
    model: {
        get(): boolean | unknown[];
        set: (value: boolean) => void;
    };
    classes(): (string | {
        'oc-checkbox-checked': boolean;
    })[];
    labelClasses(): {
        'oc-cursor-pointer': boolean;
    };
    isChecked(): boolean;
}, {
    keydownEnter(event: KeyboardEvent): void;
}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("click" | "update:modelValue")[], "click" | "update:modelValue", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
    /**
     * Id for the checkbox. If it's empty, a generated one will be used.
     */
    id: {
        type: StringConstructor;
        required: false;
        default: () => string;
    };
    /**
     * Disables the checkbox
     */
    disabled: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * The model of the checkbox. It determines, based on the option this checkbox represents, whether or not this
     * checkbox is checked. Provide it as value or bind it with v-model.
     *
     * Can be any type, but most common is boolean for singular checkbox use, or array when used in a group of checkboxes.
     **/
    modelValue: {
        type: PropType<boolean | unknown[]>;
        required: false;
        default: boolean;
    };
    /**
     * The value/object this checkbox represents.
     *
     * Can be of any type. If `value` is an array, the type of the option needs to match the value item types. If the
     * checkbox is used standalone (not in a group on a shared model) the option can be omitted.
     **/
    option: {
        required: false;
        default: any;
    };
    /**
     * Label of the Checkbox
     *
     * Always required for aria-label property. If you want to hide the label, use `hideLabel` property.
     **/
    label: {
        type: StringConstructor;
        required: true;
        default: any;
    };
    /**
     * Hide the label of the Checkbox
     */
    labelHidden: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Size of the Checkbox. Valid values are `small`, `medium` and `large`.
     * If not specified, defaults to `medium`
     */
    size: {
        type: StringConstructor;
        required: false;
        default: string;
        validator: (size: string) => boolean;
    };
    /**
     * Show outline of checkbox
     **/
    outline: {
        type: BooleanConstructor;
        required: false;
        default: boolean;
    };
}>> & Readonly<{
    onClick?: (...args: any[]) => any;
    "onUpdate:modelValue"?: (...args: any[]) => any;
}>, {
    label: string;
    option: any;
    size: string;
    id: string;
    outline: boolean;
    disabled: boolean;
    modelValue: boolean | unknown[];
    labelHidden: boolean;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;