ant-design-vue/types/checkbox/checkbox.d.ts

// Project: https://github.com/vueComponent/ant-design-vue
// Definitions by: akki-jat <https://github.com/akki-jat>
// Definitions: https://github.com/vueComponent/ant-design-vue/types

import { CheckboxGroup } from './checkbox-group';
import { AntdComponent } from '../component';

export declare class Checkbox extends AntdComponent {
  static Group: typeof CheckboxGroup;

  $props: {
    /**
     * get focus when component mounted
     * @default false
     * @type boolean
     */
    autofocus?: boolean;

    /**
     * Specifies whether the checkbox is selected.
     * @default false
     * @type boolean
     */
    checked?: boolean;

    /**
     * Specifies the initial state: whether or not the checkbox is selected.
     * @default false
     * @type boolean
     */
    defaultChecked?: boolean;

    /**
     * Disable checkbox
     * @default false
     * @type boolean
     */
    disabled?: boolean;

    /**
     * indeterminate checked state of checkbox
     * @default false
     * @type boolean
     */
    indeterminate?: boolean;

    /**
     * remove focus
     */
    blur(): void;

    /**
     * get focus
     */
    focus(): void;

    /**
     * The callback function that is triggered when the state changes.
     * @param event
     */
    onChange?: (e?: Event) => void;
  };
}